@wix/auto_sdk_blog_posts 1.0.121 → 1.0.122
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/index.d.ts +4 -4
- package/build/cjs/index.js +71 -74
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +230 -143
- package/build/cjs/index.typings.js +47 -55
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +215 -145
- package/build/cjs/meta.js +39 -29
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +4 -4
- package/build/es/index.mjs +68 -74
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +230 -143
- package/build/es/index.typings.mjs +44 -55
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +215 -145
- package/build/es/meta.mjs +39 -29
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +4 -4
- package/build/internal/cjs/index.js +71 -74
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +231 -144
- package/build/internal/cjs/index.typings.js +47 -55
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +215 -145
- package/build/internal/cjs/meta.js +39 -29
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +4 -4
- package/build/internal/es/index.mjs +68 -74
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +231 -144
- package/build/internal/es/index.typings.mjs +44 -55
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +215 -145
- package/build/internal/es/meta.mjs +39 -29
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import * as _wix_sdk_types from '@wix/sdk-types';
|
|
1
2
|
import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
|
|
2
3
|
|
|
3
4
|
interface Post {
|
|
@@ -9,7 +10,7 @@ interface Post {
|
|
|
9
10
|
_id?: string;
|
|
10
11
|
/**
|
|
11
12
|
* Post title.
|
|
12
|
-
* @maxLength
|
|
13
|
+
* @maxLength 200
|
|
13
14
|
*/
|
|
14
15
|
title?: string;
|
|
15
16
|
/**
|
|
@@ -45,23 +46,13 @@ interface Post {
|
|
|
45
46
|
/** Whether the post is pinned. If `true`, the post is placed at the top of the post list. */
|
|
46
47
|
pinned?: boolean;
|
|
47
48
|
/**
|
|
48
|
-
*
|
|
49
|
+
* Category IDs of the post. See Blog Category API for more info.
|
|
49
50
|
* @maxSize 10
|
|
50
51
|
* @format GUID
|
|
51
52
|
*/
|
|
52
53
|
categoryIds?: string[];
|
|
53
54
|
/**
|
|
54
|
-
*
|
|
55
|
-
* This property will be removed on June 30, 2023.
|
|
56
|
-
*
|
|
57
|
-
* Post cover media.
|
|
58
|
-
* @deprecated
|
|
59
|
-
* @replacedBy media
|
|
60
|
-
* @targetRemovalDate 2024-06-30
|
|
61
|
-
*/
|
|
62
|
-
coverMedia?: CoverMedia;
|
|
63
|
-
/**
|
|
64
|
-
* Post owner's [member ID](https://dev.wix.com/api/rest/members).
|
|
55
|
+
* Member ID of the post's owner.
|
|
65
56
|
* @format GUID
|
|
66
57
|
*/
|
|
67
58
|
memberId?: string;
|
|
@@ -76,10 +67,10 @@ interface Post {
|
|
|
76
67
|
commentingEnabled?: boolean;
|
|
77
68
|
/** Estimated reading time (calculated automatically). */
|
|
78
69
|
minutesToRead?: number;
|
|
79
|
-
/** Image placed at the top of the blog page. */
|
|
70
|
+
/** Image placed at the top of the blog page. Only displays on mobile devices. */
|
|
80
71
|
heroImage?: string;
|
|
81
72
|
/**
|
|
82
|
-
* IDs of
|
|
73
|
+
* IDs of tags the post is tagged with. See Blog Tags API for more info.
|
|
83
74
|
* @readonly
|
|
84
75
|
* @maxSize 30
|
|
85
76
|
* @format GUID
|
|
@@ -93,7 +84,9 @@ interface Post {
|
|
|
93
84
|
*/
|
|
94
85
|
relatedPostIds?: string[];
|
|
95
86
|
/**
|
|
96
|
-
*
|
|
87
|
+
* Pricing plan IDs. See the Pricing Plans API for more info.
|
|
88
|
+
*
|
|
89
|
+
* Only relevant if a post is assigned to a specific pricing plan.
|
|
97
90
|
* @readonly
|
|
98
91
|
* @maxSize 100
|
|
99
92
|
* @format GUID
|
|
@@ -114,13 +107,7 @@ interface Post {
|
|
|
114
107
|
/** SEO data. */
|
|
115
108
|
seoData?: SeoSchema;
|
|
116
109
|
/**
|
|
117
|
-
*
|
|
118
|
-
* @readonly
|
|
119
|
-
* @maxLength 400000
|
|
120
|
-
*/
|
|
121
|
-
content?: string | null;
|
|
122
|
-
/**
|
|
123
|
-
* Post owner's [contact ID](https://dev.wix.com/api/rest/contacts).
|
|
110
|
+
* Contact ID of the post's owner. See the Contacts API for more info.
|
|
124
111
|
* @format GUID
|
|
125
112
|
*/
|
|
126
113
|
contactId?: string | null;
|
|
@@ -139,19 +126,10 @@ interface Post {
|
|
|
139
126
|
* @readonly
|
|
140
127
|
*/
|
|
141
128
|
preview?: boolean;
|
|
142
|
-
/**
|
|
143
|
-
* Reserved for internal use.
|
|
144
|
-
* @maxLength 24
|
|
145
|
-
*/
|
|
146
|
-
contentId?: string | null;
|
|
147
|
-
/**
|
|
148
|
-
* Reserved for internal use.
|
|
149
|
-
* @readonly
|
|
150
|
-
* @format GUID
|
|
151
|
-
*/
|
|
152
|
-
mostRecentContributorId?: string | null;
|
|
153
129
|
/**
|
|
154
130
|
* Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).
|
|
131
|
+
*
|
|
132
|
+
* Guest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user.
|
|
155
133
|
* @readonly
|
|
156
134
|
*/
|
|
157
135
|
moderationDetails?: ModerationDetails;
|
|
@@ -171,17 +149,17 @@ interface Post {
|
|
|
171
149
|
}
|
|
172
150
|
interface PostCountInfo {
|
|
173
151
|
/**
|
|
174
|
-
* Total number of post comments
|
|
152
|
+
* Total number of post comments.
|
|
175
153
|
* @readonly
|
|
176
154
|
*/
|
|
177
155
|
comments?: number;
|
|
178
156
|
/**
|
|
179
|
-
* Total number of post likes
|
|
157
|
+
* Total number of post likes.
|
|
180
158
|
* @readonly
|
|
181
159
|
*/
|
|
182
160
|
likes?: number;
|
|
183
161
|
/**
|
|
184
|
-
* Total number of post views
|
|
162
|
+
* Total number of post views.
|
|
185
163
|
* @readonly
|
|
186
164
|
*/
|
|
187
165
|
views?: number;
|
|
@@ -248,21 +226,21 @@ interface Tag {
|
|
|
248
226
|
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
249
227
|
*/
|
|
250
228
|
props?: Record<string, any> | null;
|
|
251
|
-
/** SEO tag
|
|
229
|
+
/** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
|
|
252
230
|
meta?: Record<string, any> | null;
|
|
253
231
|
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
254
232
|
children?: string;
|
|
255
|
-
/** Whether the tag is a custom tag. */
|
|
233
|
+
/** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
|
|
256
234
|
custom?: boolean;
|
|
257
|
-
/** Whether the tag is disabled. */
|
|
235
|
+
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
|
|
258
236
|
disabled?: boolean;
|
|
259
237
|
}
|
|
260
238
|
interface Settings {
|
|
261
239
|
/**
|
|
262
|
-
* Whether the
|
|
240
|
+
* Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
|
|
263
241
|
*
|
|
264
242
|
*
|
|
265
|
-
* Default: `false` (
|
|
243
|
+
* Default: `false` (automatical redirect is enabled).
|
|
266
244
|
*/
|
|
267
245
|
preventAutoRedirect?: boolean;
|
|
268
246
|
/**
|
|
@@ -332,8 +310,12 @@ interface Node extends NodeDataOneOf {
|
|
|
332
310
|
blockquoteData?: BlockquoteData;
|
|
333
311
|
/** Data for a caption node. */
|
|
334
312
|
captionData?: CaptionData;
|
|
335
|
-
/**
|
|
313
|
+
/** Data for a layout node. Reserved for future use. */
|
|
314
|
+
layoutData?: LayoutData;
|
|
315
|
+
/** Data for a cell node. */
|
|
336
316
|
layoutCellData?: LayoutCellData;
|
|
317
|
+
/** Data for a shape node. */
|
|
318
|
+
shapeData?: ShapeData;
|
|
337
319
|
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
338
320
|
type?: NodeTypeWithLiterals;
|
|
339
321
|
/** Node ID. */
|
|
@@ -397,8 +379,12 @@ interface NodeDataOneOf {
|
|
|
397
379
|
blockquoteData?: BlockquoteData;
|
|
398
380
|
/** Data for a caption node. */
|
|
399
381
|
captionData?: CaptionData;
|
|
400
|
-
/**
|
|
382
|
+
/** Data for a layout node. Reserved for future use. */
|
|
383
|
+
layoutData?: LayoutData;
|
|
384
|
+
/** Data for a cell node. */
|
|
401
385
|
layoutCellData?: LayoutCellData;
|
|
386
|
+
/** Data for a shape node. */
|
|
387
|
+
shapeData?: ShapeData;
|
|
402
388
|
}
|
|
403
389
|
declare enum NodeType {
|
|
404
390
|
PARAGRAPH = "PARAGRAPH",
|
|
@@ -434,10 +420,11 @@ declare enum NodeType {
|
|
|
434
420
|
AUDIO = "AUDIO",
|
|
435
421
|
CAPTION = "CAPTION",
|
|
436
422
|
LAYOUT = "LAYOUT",
|
|
437
|
-
LAYOUT_CELL = "LAYOUT_CELL"
|
|
423
|
+
LAYOUT_CELL = "LAYOUT_CELL",
|
|
424
|
+
SHAPE = "SHAPE"
|
|
438
425
|
}
|
|
439
426
|
/** @enumType */
|
|
440
|
-
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
427
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL' | 'SHAPE';
|
|
441
428
|
interface NodeStyle {
|
|
442
429
|
/** The top padding value in pixels. */
|
|
443
430
|
paddingTop?: string | null;
|
|
@@ -459,17 +446,32 @@ interface ButtonData {
|
|
|
459
446
|
link?: Link;
|
|
460
447
|
}
|
|
461
448
|
interface Border {
|
|
462
|
-
/**
|
|
449
|
+
/**
|
|
450
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
451
|
+
* @deprecated
|
|
452
|
+
*/
|
|
463
453
|
width?: number | null;
|
|
464
|
-
/**
|
|
454
|
+
/**
|
|
455
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
456
|
+
* @deprecated
|
|
457
|
+
*/
|
|
465
458
|
radius?: number | null;
|
|
466
459
|
}
|
|
467
460
|
interface Colors {
|
|
468
|
-
/**
|
|
461
|
+
/**
|
|
462
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
463
|
+
* @deprecated
|
|
464
|
+
*/
|
|
469
465
|
text?: string | null;
|
|
470
|
-
/**
|
|
466
|
+
/**
|
|
467
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
468
|
+
* @deprecated
|
|
469
|
+
*/
|
|
471
470
|
border?: string | null;
|
|
472
|
-
/**
|
|
471
|
+
/**
|
|
472
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
473
|
+
* @deprecated
|
|
474
|
+
*/
|
|
473
475
|
background?: string | null;
|
|
474
476
|
}
|
|
475
477
|
interface PluginContainerData {
|
|
@@ -552,10 +554,57 @@ declare enum ButtonDataType {
|
|
|
552
554
|
/** @enumType */
|
|
553
555
|
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
554
556
|
interface Styles {
|
|
555
|
-
/**
|
|
557
|
+
/**
|
|
558
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
559
|
+
* @deprecated
|
|
560
|
+
*/
|
|
556
561
|
border?: Border;
|
|
557
|
-
/**
|
|
562
|
+
/**
|
|
563
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
564
|
+
* @deprecated
|
|
565
|
+
*/
|
|
558
566
|
colors?: Colors;
|
|
567
|
+
/** Border width in pixels. */
|
|
568
|
+
borderWidth?: number | null;
|
|
569
|
+
/**
|
|
570
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
571
|
+
* @deprecated
|
|
572
|
+
*/
|
|
573
|
+
borderWidthHover?: number | null;
|
|
574
|
+
/** Border radius in pixels. */
|
|
575
|
+
borderRadius?: number | null;
|
|
576
|
+
/**
|
|
577
|
+
* Border color as a hexadecimal value.
|
|
578
|
+
* @format COLOR_HEX
|
|
579
|
+
*/
|
|
580
|
+
borderColor?: string | null;
|
|
581
|
+
/**
|
|
582
|
+
* Border color as a hexadecimal value (hover state).
|
|
583
|
+
* @format COLOR_HEX
|
|
584
|
+
*/
|
|
585
|
+
borderColorHover?: string | null;
|
|
586
|
+
/**
|
|
587
|
+
* Text color as a hexadecimal value.
|
|
588
|
+
* @format COLOR_HEX
|
|
589
|
+
*/
|
|
590
|
+
textColor?: string | null;
|
|
591
|
+
/**
|
|
592
|
+
* Text color as a hexadecimal value (hover state).
|
|
593
|
+
* @format COLOR_HEX
|
|
594
|
+
*/
|
|
595
|
+
textColorHover?: string | null;
|
|
596
|
+
/**
|
|
597
|
+
* Background color as a hexadecimal value.
|
|
598
|
+
* @format COLOR_HEX
|
|
599
|
+
*/
|
|
600
|
+
backgroundColor?: string | null;
|
|
601
|
+
/**
|
|
602
|
+
* Background color as a hexadecimal value (hover state).
|
|
603
|
+
* @format COLOR_HEX
|
|
604
|
+
*/
|
|
605
|
+
backgroundColorHover?: string | null;
|
|
606
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
607
|
+
buttonSize?: string | null;
|
|
559
608
|
}
|
|
560
609
|
interface Link extends LinkDataOneOf {
|
|
561
610
|
/** The absolute URL for the linked document. */
|
|
@@ -893,7 +942,7 @@ interface GIFData {
|
|
|
893
942
|
height?: number;
|
|
894
943
|
/** Width in pixels. */
|
|
895
944
|
width?: number;
|
|
896
|
-
/** Type of GIF (Sticker or
|
|
945
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
897
946
|
gifType?: GIFTypeWithLiterals;
|
|
898
947
|
}
|
|
899
948
|
interface GIF {
|
|
@@ -914,11 +963,11 @@ interface GIF {
|
|
|
914
963
|
still?: string | null;
|
|
915
964
|
}
|
|
916
965
|
declare enum GIFType {
|
|
917
|
-
|
|
966
|
+
NORMAL = "NORMAL",
|
|
918
967
|
STICKER = "STICKER"
|
|
919
968
|
}
|
|
920
969
|
/** @enumType */
|
|
921
|
-
type GIFTypeWithLiterals = GIFType | '
|
|
970
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
922
971
|
interface HeadingData {
|
|
923
972
|
/** Heading level from 1-6. */
|
|
924
973
|
level?: number;
|
|
@@ -958,10 +1007,11 @@ interface HTMLDataDataOneOf {
|
|
|
958
1007
|
}
|
|
959
1008
|
declare enum Source {
|
|
960
1009
|
HTML = "HTML",
|
|
961
|
-
ADSENSE = "ADSENSE"
|
|
1010
|
+
ADSENSE = "ADSENSE",
|
|
1011
|
+
AI = "AI"
|
|
962
1012
|
}
|
|
963
1013
|
/** @enumType */
|
|
964
|
-
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1014
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE' | 'AI';
|
|
965
1015
|
interface ImageData {
|
|
966
1016
|
/** Styling for the image's container. */
|
|
967
1017
|
containerData?: PluginContainerData;
|
|
@@ -980,6 +1030,10 @@ interface ImageData {
|
|
|
980
1030
|
caption?: string | null;
|
|
981
1031
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
982
1032
|
disableDownload?: boolean | null;
|
|
1033
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1034
|
+
decorative?: boolean | null;
|
|
1035
|
+
/** Styling for the image. */
|
|
1036
|
+
styles?: ImageDataStyles;
|
|
983
1037
|
}
|
|
984
1038
|
interface StylesBorder {
|
|
985
1039
|
/** Border width in pixels. */
|
|
@@ -1009,6 +1063,8 @@ interface LinkPreviewData {
|
|
|
1009
1063
|
description?: string | null;
|
|
1010
1064
|
/** The preview content as HTML. */
|
|
1011
1065
|
html?: string | null;
|
|
1066
|
+
/** Styling for the link preview. */
|
|
1067
|
+
styles?: LinkPreviewDataStyles;
|
|
1012
1068
|
}
|
|
1013
1069
|
declare enum StylesPosition {
|
|
1014
1070
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
@@ -1296,6 +1352,14 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1296
1352
|
underlineData?: boolean | null;
|
|
1297
1353
|
/** Data for a spoiler decoration. */
|
|
1298
1354
|
spoilerData?: SpoilerData;
|
|
1355
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1356
|
+
strikethroughData?: boolean | null;
|
|
1357
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1358
|
+
superscriptData?: boolean | null;
|
|
1359
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1360
|
+
subscriptData?: boolean | null;
|
|
1361
|
+
/** Data for a font family decoration. */
|
|
1362
|
+
fontFamilyData?: FontFamilyData;
|
|
1299
1363
|
/** The type of decoration to apply. */
|
|
1300
1364
|
type?: DecorationTypeWithLiterals;
|
|
1301
1365
|
}
|
|
@@ -1319,6 +1383,14 @@ interface DecorationDataOneOf {
|
|
|
1319
1383
|
underlineData?: boolean | null;
|
|
1320
1384
|
/** Data for a spoiler decoration. */
|
|
1321
1385
|
spoilerData?: SpoilerData;
|
|
1386
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1387
|
+
strikethroughData?: boolean | null;
|
|
1388
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1389
|
+
superscriptData?: boolean | null;
|
|
1390
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1391
|
+
subscriptData?: boolean | null;
|
|
1392
|
+
/** Data for a font family decoration. */
|
|
1393
|
+
fontFamilyData?: FontFamilyData;
|
|
1322
1394
|
}
|
|
1323
1395
|
declare enum DecorationType {
|
|
1324
1396
|
BOLD = "BOLD",
|
|
@@ -1330,10 +1402,14 @@ declare enum DecorationType {
|
|
|
1330
1402
|
LINK = "LINK",
|
|
1331
1403
|
COLOR = "COLOR",
|
|
1332
1404
|
FONT_SIZE = "FONT_SIZE",
|
|
1333
|
-
EXTERNAL = "EXTERNAL"
|
|
1405
|
+
EXTERNAL = "EXTERNAL",
|
|
1406
|
+
STRIKETHROUGH = "STRIKETHROUGH",
|
|
1407
|
+
SUPERSCRIPT = "SUPERSCRIPT",
|
|
1408
|
+
SUBSCRIPT = "SUBSCRIPT",
|
|
1409
|
+
FONT_FAMILY = "FONT_FAMILY"
|
|
1334
1410
|
}
|
|
1335
1411
|
/** @enumType */
|
|
1336
|
-
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
|
1412
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY';
|
|
1337
1413
|
interface AnchorData {
|
|
1338
1414
|
/** The target node's ID. */
|
|
1339
1415
|
anchor?: string;
|
|
@@ -1396,6 +1472,36 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1396
1472
|
url?: string | null;
|
|
1397
1473
|
/** An image for the embedded content. */
|
|
1398
1474
|
image?: V1Media;
|
|
1475
|
+
/** Whether to hide the image. */
|
|
1476
|
+
hideImage?: boolean | null;
|
|
1477
|
+
/** Whether to hide the title. */
|
|
1478
|
+
hideTitle?: boolean | null;
|
|
1479
|
+
/** Whether to hide the price. */
|
|
1480
|
+
hidePrice?: boolean | null;
|
|
1481
|
+
/** Whether to hide the description (Event and Booking). */
|
|
1482
|
+
hideDescription?: boolean | null;
|
|
1483
|
+
/** Whether to hide the date and time (Event). */
|
|
1484
|
+
hideDateTime?: boolean | null;
|
|
1485
|
+
/** Whether to hide the location (Event). */
|
|
1486
|
+
hideLocation?: boolean | null;
|
|
1487
|
+
/** Whether to hide the duration (Booking). */
|
|
1488
|
+
hideDuration?: boolean | null;
|
|
1489
|
+
/** Whether to hide the button. */
|
|
1490
|
+
hideButton?: boolean | null;
|
|
1491
|
+
/** Whether to hide the ribbon. */
|
|
1492
|
+
hideRibbon?: boolean | null;
|
|
1493
|
+
/** Button styling options. */
|
|
1494
|
+
buttonStyles?: ButtonStyles;
|
|
1495
|
+
/** Image styling options. */
|
|
1496
|
+
imageStyles?: ImageStyles;
|
|
1497
|
+
/** Ribbon styling options. */
|
|
1498
|
+
ribbonStyles?: RibbonStyles;
|
|
1499
|
+
/** Card styling options. */
|
|
1500
|
+
cardStyles?: CardStyles;
|
|
1501
|
+
/** Styling for the app embed's container. */
|
|
1502
|
+
containerData?: PluginContainerData;
|
|
1503
|
+
/** Pricing data for embedded Wix App content. */
|
|
1504
|
+
pricingData?: PricingData;
|
|
1399
1505
|
}
|
|
1400
1506
|
/** @oneof */
|
|
1401
1507
|
interface AppEmbedDataAppDataOneOf {
|
|
@@ -1730,6 +1836,13 @@ interface TableData {
|
|
|
1730
1836
|
rowHeader?: boolean | null;
|
|
1731
1837
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1732
1838
|
columnHeader?: boolean | null;
|
|
1839
|
+
/** The spacing between cells in pixels. Defaults to `0`. */
|
|
1840
|
+
cellSpacing?: number | null;
|
|
1841
|
+
/**
|
|
1842
|
+
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
|
|
1843
|
+
* @maxSize 4
|
|
1844
|
+
*/
|
|
1845
|
+
cellPadding?: number[];
|
|
1733
1846
|
}
|
|
1734
1847
|
interface Dimensions {
|
|
1735
1848
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
@@ -1744,6 +1857,12 @@ interface TableCellData {
|
|
|
1744
1857
|
cellStyle?: CellStyle;
|
|
1745
1858
|
/** The cell's border colors. */
|
|
1746
1859
|
borderColors?: BorderColors;
|
|
1860
|
+
/** Defines how many columns the cell spans. Default: 1. */
|
|
1861
|
+
colspan?: number | null;
|
|
1862
|
+
/** Defines how many rows the cell spans. Default: 1. */
|
|
1863
|
+
rowspan?: number | null;
|
|
1864
|
+
/** The cell's border widths. */
|
|
1865
|
+
borderWidths?: BorderWidths;
|
|
1747
1866
|
}
|
|
1748
1867
|
declare enum VerticalAlignment {
|
|
1749
1868
|
/** Top alignment */
|
|
@@ -1972,6 +2091,23 @@ interface LayoutCellData {
|
|
|
1972
2091
|
/** Size of the cell in 12 columns grid. */
|
|
1973
2092
|
colSpan?: number | null;
|
|
1974
2093
|
}
|
|
2094
|
+
interface ShapeData {
|
|
2095
|
+
/** Styling for the shape's container. */
|
|
2096
|
+
containerData?: PluginContainerData;
|
|
2097
|
+
/** Shape file details. */
|
|
2098
|
+
shape?: V1Media;
|
|
2099
|
+
/** Styling for the shape. */
|
|
2100
|
+
styles?: ShapeDataStyles;
|
|
2101
|
+
}
|
|
2102
|
+
interface ShapeDataStyles {
|
|
2103
|
+
/**
|
|
2104
|
+
* Shape fill color as a hexadecimal value.
|
|
2105
|
+
* @format COLOR_HEX
|
|
2106
|
+
*/
|
|
2107
|
+
color?: string | null;
|
|
2108
|
+
/** Map of original color keys to their new color values. */
|
|
2109
|
+
colors?: Record<string, string>;
|
|
2110
|
+
}
|
|
1975
2111
|
interface Metadata {
|
|
1976
2112
|
/** Schema version. */
|
|
1977
2113
|
version?: number;
|
|
@@ -2121,7 +2257,11 @@ interface PostTranslation {
|
|
|
2121
2257
|
*/
|
|
2122
2258
|
language?: string | null;
|
|
2123
2259
|
/**
|
|
2124
|
-
* Post slug.
|
|
2260
|
+
* Post slug.
|
|
2261
|
+
*
|
|
2262
|
+
* The slug is the end of a post's URL that refers to a specific post.
|
|
2263
|
+
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
|
|
2264
|
+
* the slug is `my-post-slug`. The slug is case-sensitive.
|
|
2125
2265
|
* @maxLength 100
|
|
2126
2266
|
*/
|
|
2127
2267
|
slug?: string | null;
|
|
@@ -2668,25 +2808,21 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2668
2808
|
updatedEvent?: EntityUpdatedEvent;
|
|
2669
2809
|
deletedEvent?: EntityDeletedEvent;
|
|
2670
2810
|
actionEvent?: ActionEvent;
|
|
2671
|
-
/**
|
|
2672
|
-
* Unique event ID.
|
|
2673
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2674
|
-
*/
|
|
2811
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2675
2812
|
_id?: string;
|
|
2676
2813
|
/**
|
|
2677
|
-
*
|
|
2678
|
-
*
|
|
2814
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2815
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2679
2816
|
*/
|
|
2680
2817
|
entityFqdn?: string;
|
|
2681
2818
|
/**
|
|
2682
|
-
*
|
|
2683
|
-
*
|
|
2684
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2819
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2820
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2685
2821
|
*/
|
|
2686
2822
|
slug?: string;
|
|
2687
2823
|
/** ID of the entity associated with the event. */
|
|
2688
2824
|
entityId?: string;
|
|
2689
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
2825
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2690
2826
|
eventTime?: Date | null;
|
|
2691
2827
|
/**
|
|
2692
2828
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -2696,12 +2832,8 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2696
2832
|
/** If present, indicates the action that triggered the event. */
|
|
2697
2833
|
originatedFrom?: string | null;
|
|
2698
2834
|
/**
|
|
2699
|
-
* A sequence number
|
|
2700
|
-
*
|
|
2701
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2702
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2703
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2704
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2835
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
2836
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
2705
2837
|
*/
|
|
2706
2838
|
entityEventSequence?: string | null;
|
|
2707
2839
|
}
|
|
@@ -2727,7 +2859,7 @@ interface EntityUpdatedEvent {
|
|
|
2727
2859
|
currentEntity?: string;
|
|
2728
2860
|
}
|
|
2729
2861
|
interface EntityDeletedEvent {
|
|
2730
|
-
/** Entity that was deleted */
|
|
2862
|
+
/** Entity that was deleted. */
|
|
2731
2863
|
deletedEntity?: string | null;
|
|
2732
2864
|
}
|
|
2733
2865
|
interface ActionEvent {
|
|
@@ -2748,6 +2880,8 @@ interface MessageEnvelope {
|
|
|
2748
2880
|
identity?: IdentificationData;
|
|
2749
2881
|
/** Stringify payload. */
|
|
2750
2882
|
data?: string;
|
|
2883
|
+
/** Details related to the account */
|
|
2884
|
+
accountInfo?: AccountInfo;
|
|
2751
2885
|
}
|
|
2752
2886
|
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2753
2887
|
/**
|
|
@@ -3586,50 +3720,6 @@ interface ConvertRichContentToDraftJsResponse {
|
|
|
3586
3720
|
/** DraftJs content converted from Rich content. */
|
|
3587
3721
|
content?: Record<string, any> | null;
|
|
3588
3722
|
}
|
|
3589
|
-
interface CoverMedia extends CoverMediaMediaOneOf {
|
|
3590
|
-
/** Image url. */
|
|
3591
|
-
image?: string;
|
|
3592
|
-
/** Video url. */
|
|
3593
|
-
video?: string;
|
|
3594
|
-
/**
|
|
3595
|
-
* Is cover media enabled.
|
|
3596
|
-
* Selected by user whether to display cover media on the feed
|
|
3597
|
-
* @deprecated Is cover media enabled.
|
|
3598
|
-
* Selected by user whether to display cover media on the feed
|
|
3599
|
-
* @replacedBy displayed
|
|
3600
|
-
* @targetRemovalDate 2024-06-30
|
|
3601
|
-
*/
|
|
3602
|
-
enabled?: boolean;
|
|
3603
|
-
/** Whether cover media is displayed. */
|
|
3604
|
-
displayed?: boolean;
|
|
3605
|
-
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
|
|
3606
|
-
custom?: boolean;
|
|
3607
|
-
/**
|
|
3608
|
-
* Media alternative text.
|
|
3609
|
-
* @minLength 1
|
|
3610
|
-
* @maxLength 1000
|
|
3611
|
-
*/
|
|
3612
|
-
altText?: string | null;
|
|
3613
|
-
}
|
|
3614
|
-
/** @oneof */
|
|
3615
|
-
interface CoverMediaMediaOneOf {
|
|
3616
|
-
/** Image url. */
|
|
3617
|
-
image?: string;
|
|
3618
|
-
/** Video url. */
|
|
3619
|
-
video?: string;
|
|
3620
|
-
}
|
|
3621
|
-
interface OldBlogMigratedEvent {
|
|
3622
|
-
/**
|
|
3623
|
-
* Instance id of new version of blog
|
|
3624
|
-
* @format GUID
|
|
3625
|
-
*/
|
|
3626
|
-
newBlogInstanceId?: string;
|
|
3627
|
-
/**
|
|
3628
|
-
* Instance id of old version of blog
|
|
3629
|
-
* @format GUID
|
|
3630
|
-
*/
|
|
3631
|
-
oldBlogInstanceId?: string;
|
|
3632
|
-
}
|
|
3633
3723
|
interface BaseEventMetadata {
|
|
3634
3724
|
/**
|
|
3635
3725
|
* App instance ID.
|
|
@@ -3643,27 +3733,25 @@ interface BaseEventMetadata {
|
|
|
3643
3733
|
eventType?: string;
|
|
3644
3734
|
/** The identification type and identity data. */
|
|
3645
3735
|
identity?: IdentificationData;
|
|
3736
|
+
/** Details related to the account */
|
|
3737
|
+
accountInfo?: AccountInfo;
|
|
3646
3738
|
}
|
|
3647
3739
|
interface EventMetadata extends BaseEventMetadata {
|
|
3648
|
-
/**
|
|
3649
|
-
* Unique event ID.
|
|
3650
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3651
|
-
*/
|
|
3740
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3652
3741
|
_id?: string;
|
|
3653
3742
|
/**
|
|
3654
|
-
*
|
|
3655
|
-
*
|
|
3743
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3744
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3656
3745
|
*/
|
|
3657
3746
|
entityFqdn?: string;
|
|
3658
3747
|
/**
|
|
3659
|
-
*
|
|
3660
|
-
*
|
|
3661
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3748
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3749
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3662
3750
|
*/
|
|
3663
3751
|
slug?: string;
|
|
3664
3752
|
/** ID of the entity associated with the event. */
|
|
3665
3753
|
entityId?: string;
|
|
3666
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
3754
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3667
3755
|
eventTime?: Date | null;
|
|
3668
3756
|
/**
|
|
3669
3757
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -3673,12 +3761,8 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
3673
3761
|
/** If present, indicates the action that triggered the event. */
|
|
3674
3762
|
originatedFrom?: string | null;
|
|
3675
3763
|
/**
|
|
3676
|
-
* A sequence number
|
|
3677
|
-
*
|
|
3678
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3679
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3680
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3681
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3764
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3765
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3682
3766
|
*/
|
|
3683
3767
|
entityEventSequence?: string | null;
|
|
3684
3768
|
accountInfo?: AccountInfoMetadata;
|
|
@@ -3857,7 +3941,7 @@ interface GetTotalPostsOptions {
|
|
|
3857
3941
|
* @applicableIdentity APP
|
|
3858
3942
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3859
3943
|
*/
|
|
3860
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.
|
|
3944
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
|
|
3861
3945
|
interface GetPostOptions {
|
|
3862
3946
|
/**
|
|
3863
3947
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3882,7 +3966,7 @@ interface GetPostOptions {
|
|
|
3882
3966
|
* @applicableIdentity APP
|
|
3883
3967
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
3884
3968
|
*/
|
|
3885
|
-
declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.
|
|
3969
|
+
declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
|
|
3886
3970
|
interface GetPostBySlugOptions {
|
|
3887
3971
|
/**
|
|
3888
3972
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3910,7 +3994,7 @@ interface GetPostBySlugOptions {
|
|
|
3910
3994
|
* @applicableIdentity APP
|
|
3911
3995
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
3912
3996
|
*/
|
|
3913
|
-
declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.
|
|
3997
|
+
declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges` | `metaData.count` | `metaData.offset` | `metaData.total`, 6>>;
|
|
3914
3998
|
interface ListPostsOptions {
|
|
3915
3999
|
/**
|
|
3916
4000
|
* Whether to return only featured posts.
|
|
@@ -4077,7 +4161,7 @@ interface PostsQueryBuilder {
|
|
|
4077
4161
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
4078
4162
|
* @requiredField query
|
|
4079
4163
|
*/
|
|
4080
|
-
declare function typedQueryPosts(query: PostQuery, options?: QueryPostsOptions): Promise<NonNullablePaths<QueryPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.
|
|
4164
|
+
declare function typedQueryPosts(query: PostQuery, options?: QueryPostsOptions): Promise<NonNullablePaths<QueryPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges`, 6>>;
|
|
4081
4165
|
interface PostQuerySpec extends QuerySpec {
|
|
4082
4166
|
paging: 'cursor';
|
|
4083
4167
|
wql: [];
|
|
@@ -4129,6 +4213,9 @@ type PostQuery = {
|
|
|
4129
4213
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
4130
4214
|
}[];
|
|
4131
4215
|
};
|
|
4216
|
+
declare const QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
|
|
4217
|
+
declare const Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
|
|
4218
|
+
declare const Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
|
|
4132
4219
|
/**
|
|
4133
4220
|
* Retrieves a post's metrics.
|
|
4134
4221
|
*
|
|
@@ -4142,4 +4229,4 @@ type PostQuery = {
|
|
|
4142
4229
|
*/
|
|
4143
4230
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4144
4231
|
|
|
4145
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type
|
|
4232
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, Filter, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, QueryBuilder, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts };
|