@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,26 +126,17 @@ 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;
|
|
158
136
|
/** Post cover media. */
|
|
159
137
|
media?: Media;
|
|
160
138
|
/**
|
|
161
|
-
* Post rich content as a string
|
|
139
|
+
* Post rich content as a string.
|
|
162
140
|
* @internal
|
|
163
141
|
* @readonly
|
|
164
142
|
* @maxLength 8000000
|
|
@@ -178,17 +156,17 @@ interface Post {
|
|
|
178
156
|
}
|
|
179
157
|
interface PostCountInfo {
|
|
180
158
|
/**
|
|
181
|
-
* Total number of post comments
|
|
159
|
+
* Total number of post comments.
|
|
182
160
|
* @readonly
|
|
183
161
|
*/
|
|
184
162
|
comments?: number;
|
|
185
163
|
/**
|
|
186
|
-
* Total number of post likes
|
|
164
|
+
* Total number of post likes.
|
|
187
165
|
* @readonly
|
|
188
166
|
*/
|
|
189
167
|
likes?: number;
|
|
190
168
|
/**
|
|
191
|
-
* Total number of post views
|
|
169
|
+
* Total number of post views.
|
|
192
170
|
* @readonly
|
|
193
171
|
*/
|
|
194
172
|
views?: number;
|
|
@@ -255,21 +233,21 @@ interface Tag {
|
|
|
255
233
|
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
256
234
|
*/
|
|
257
235
|
props?: Record<string, any> | null;
|
|
258
|
-
/** SEO tag
|
|
236
|
+
/** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
|
|
259
237
|
meta?: Record<string, any> | null;
|
|
260
238
|
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
261
239
|
children?: string;
|
|
262
|
-
/** Whether the tag is a custom tag. */
|
|
240
|
+
/** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
|
|
263
241
|
custom?: boolean;
|
|
264
|
-
/** Whether the tag is disabled. */
|
|
242
|
+
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
|
|
265
243
|
disabled?: boolean;
|
|
266
244
|
}
|
|
267
245
|
interface Settings {
|
|
268
246
|
/**
|
|
269
|
-
* Whether the
|
|
247
|
+
* 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.
|
|
270
248
|
*
|
|
271
249
|
*
|
|
272
|
-
* Default: `false` (
|
|
250
|
+
* Default: `false` (automatical redirect is enabled).
|
|
273
251
|
*/
|
|
274
252
|
preventAutoRedirect?: boolean;
|
|
275
253
|
/**
|
|
@@ -339,8 +317,12 @@ interface Node extends NodeDataOneOf {
|
|
|
339
317
|
blockquoteData?: BlockquoteData;
|
|
340
318
|
/** Data for a caption node. */
|
|
341
319
|
captionData?: CaptionData;
|
|
342
|
-
/**
|
|
320
|
+
/** Data for a layout node. Reserved for future use. */
|
|
321
|
+
layoutData?: LayoutData;
|
|
322
|
+
/** Data for a cell node. */
|
|
343
323
|
layoutCellData?: LayoutCellData;
|
|
324
|
+
/** Data for a shape node. */
|
|
325
|
+
shapeData?: ShapeData;
|
|
344
326
|
/** 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. */
|
|
345
327
|
type?: NodeTypeWithLiterals;
|
|
346
328
|
/** Node ID. */
|
|
@@ -404,8 +386,12 @@ interface NodeDataOneOf {
|
|
|
404
386
|
blockquoteData?: BlockquoteData;
|
|
405
387
|
/** Data for a caption node. */
|
|
406
388
|
captionData?: CaptionData;
|
|
407
|
-
/**
|
|
389
|
+
/** Data for a layout node. Reserved for future use. */
|
|
390
|
+
layoutData?: LayoutData;
|
|
391
|
+
/** Data for a cell node. */
|
|
408
392
|
layoutCellData?: LayoutCellData;
|
|
393
|
+
/** Data for a shape node. */
|
|
394
|
+
shapeData?: ShapeData;
|
|
409
395
|
}
|
|
410
396
|
declare enum NodeType {
|
|
411
397
|
PARAGRAPH = "PARAGRAPH",
|
|
@@ -441,10 +427,11 @@ declare enum NodeType {
|
|
|
441
427
|
AUDIO = "AUDIO",
|
|
442
428
|
CAPTION = "CAPTION",
|
|
443
429
|
LAYOUT = "LAYOUT",
|
|
444
|
-
LAYOUT_CELL = "LAYOUT_CELL"
|
|
430
|
+
LAYOUT_CELL = "LAYOUT_CELL",
|
|
431
|
+
SHAPE = "SHAPE"
|
|
445
432
|
}
|
|
446
433
|
/** @enumType */
|
|
447
|
-
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';
|
|
434
|
+
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';
|
|
448
435
|
interface NodeStyle {
|
|
449
436
|
/** The top padding value in pixels. */
|
|
450
437
|
paddingTop?: string | null;
|
|
@@ -466,17 +453,32 @@ interface ButtonData {
|
|
|
466
453
|
link?: Link;
|
|
467
454
|
}
|
|
468
455
|
interface Border {
|
|
469
|
-
/**
|
|
456
|
+
/**
|
|
457
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
458
|
+
* @deprecated
|
|
459
|
+
*/
|
|
470
460
|
width?: number | null;
|
|
471
|
-
/**
|
|
461
|
+
/**
|
|
462
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
463
|
+
* @deprecated
|
|
464
|
+
*/
|
|
472
465
|
radius?: number | null;
|
|
473
466
|
}
|
|
474
467
|
interface Colors {
|
|
475
|
-
/**
|
|
468
|
+
/**
|
|
469
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
470
|
+
* @deprecated
|
|
471
|
+
*/
|
|
476
472
|
text?: string | null;
|
|
477
|
-
/**
|
|
473
|
+
/**
|
|
474
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
475
|
+
* @deprecated
|
|
476
|
+
*/
|
|
478
477
|
border?: string | null;
|
|
479
|
-
/**
|
|
478
|
+
/**
|
|
479
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
480
|
+
* @deprecated
|
|
481
|
+
*/
|
|
480
482
|
background?: string | null;
|
|
481
483
|
}
|
|
482
484
|
interface PluginContainerData {
|
|
@@ -559,10 +561,57 @@ declare enum ButtonDataType {
|
|
|
559
561
|
/** @enumType */
|
|
560
562
|
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
561
563
|
interface Styles {
|
|
562
|
-
/**
|
|
564
|
+
/**
|
|
565
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
566
|
+
* @deprecated
|
|
567
|
+
*/
|
|
563
568
|
border?: Border;
|
|
564
|
-
/**
|
|
569
|
+
/**
|
|
570
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
571
|
+
* @deprecated
|
|
572
|
+
*/
|
|
565
573
|
colors?: Colors;
|
|
574
|
+
/** Border width in pixels. */
|
|
575
|
+
borderWidth?: number | null;
|
|
576
|
+
/**
|
|
577
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
578
|
+
* @deprecated
|
|
579
|
+
*/
|
|
580
|
+
borderWidthHover?: number | null;
|
|
581
|
+
/** Border radius in pixels. */
|
|
582
|
+
borderRadius?: number | null;
|
|
583
|
+
/**
|
|
584
|
+
* Border color as a hexadecimal value.
|
|
585
|
+
* @format COLOR_HEX
|
|
586
|
+
*/
|
|
587
|
+
borderColor?: string | null;
|
|
588
|
+
/**
|
|
589
|
+
* Border color as a hexadecimal value (hover state).
|
|
590
|
+
* @format COLOR_HEX
|
|
591
|
+
*/
|
|
592
|
+
borderColorHover?: string | null;
|
|
593
|
+
/**
|
|
594
|
+
* Text color as a hexadecimal value.
|
|
595
|
+
* @format COLOR_HEX
|
|
596
|
+
*/
|
|
597
|
+
textColor?: string | null;
|
|
598
|
+
/**
|
|
599
|
+
* Text color as a hexadecimal value (hover state).
|
|
600
|
+
* @format COLOR_HEX
|
|
601
|
+
*/
|
|
602
|
+
textColorHover?: string | null;
|
|
603
|
+
/**
|
|
604
|
+
* Background color as a hexadecimal value.
|
|
605
|
+
* @format COLOR_HEX
|
|
606
|
+
*/
|
|
607
|
+
backgroundColor?: string | null;
|
|
608
|
+
/**
|
|
609
|
+
* Background color as a hexadecimal value (hover state).
|
|
610
|
+
* @format COLOR_HEX
|
|
611
|
+
*/
|
|
612
|
+
backgroundColorHover?: string | null;
|
|
613
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
614
|
+
buttonSize?: string | null;
|
|
566
615
|
}
|
|
567
616
|
interface Link extends LinkDataOneOf {
|
|
568
617
|
/** The absolute URL for the linked document. */
|
|
@@ -900,7 +949,7 @@ interface GIFData {
|
|
|
900
949
|
height?: number;
|
|
901
950
|
/** Width in pixels. */
|
|
902
951
|
width?: number;
|
|
903
|
-
/** Type of GIF (Sticker or
|
|
952
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
904
953
|
gifType?: GIFTypeWithLiterals;
|
|
905
954
|
}
|
|
906
955
|
interface GIF {
|
|
@@ -921,11 +970,11 @@ interface GIF {
|
|
|
921
970
|
still?: string | null;
|
|
922
971
|
}
|
|
923
972
|
declare enum GIFType {
|
|
924
|
-
|
|
973
|
+
NORMAL = "NORMAL",
|
|
925
974
|
STICKER = "STICKER"
|
|
926
975
|
}
|
|
927
976
|
/** @enumType */
|
|
928
|
-
type GIFTypeWithLiterals = GIFType | '
|
|
977
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
929
978
|
interface HeadingData {
|
|
930
979
|
/** Heading level from 1-6. */
|
|
931
980
|
level?: number;
|
|
@@ -965,10 +1014,11 @@ interface HTMLDataDataOneOf {
|
|
|
965
1014
|
}
|
|
966
1015
|
declare enum Source {
|
|
967
1016
|
HTML = "HTML",
|
|
968
|
-
ADSENSE = "ADSENSE"
|
|
1017
|
+
ADSENSE = "ADSENSE",
|
|
1018
|
+
AI = "AI"
|
|
969
1019
|
}
|
|
970
1020
|
/** @enumType */
|
|
971
|
-
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1021
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE' | 'AI';
|
|
972
1022
|
interface ImageData {
|
|
973
1023
|
/** Styling for the image's container. */
|
|
974
1024
|
containerData?: PluginContainerData;
|
|
@@ -987,6 +1037,10 @@ interface ImageData {
|
|
|
987
1037
|
caption?: string | null;
|
|
988
1038
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
989
1039
|
disableDownload?: boolean | null;
|
|
1040
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1041
|
+
decorative?: boolean | null;
|
|
1042
|
+
/** Styling for the image. */
|
|
1043
|
+
styles?: ImageDataStyles;
|
|
990
1044
|
}
|
|
991
1045
|
interface StylesBorder {
|
|
992
1046
|
/** Border width in pixels. */
|
|
@@ -1016,6 +1070,8 @@ interface LinkPreviewData {
|
|
|
1016
1070
|
description?: string | null;
|
|
1017
1071
|
/** The preview content as HTML. */
|
|
1018
1072
|
html?: string | null;
|
|
1073
|
+
/** Styling for the link preview. */
|
|
1074
|
+
styles?: LinkPreviewDataStyles;
|
|
1019
1075
|
}
|
|
1020
1076
|
declare enum StylesPosition {
|
|
1021
1077
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
@@ -1303,6 +1359,14 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1303
1359
|
underlineData?: boolean | null;
|
|
1304
1360
|
/** Data for a spoiler decoration. */
|
|
1305
1361
|
spoilerData?: SpoilerData;
|
|
1362
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1363
|
+
strikethroughData?: boolean | null;
|
|
1364
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1365
|
+
superscriptData?: boolean | null;
|
|
1366
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1367
|
+
subscriptData?: boolean | null;
|
|
1368
|
+
/** Data for a font family decoration. */
|
|
1369
|
+
fontFamilyData?: FontFamilyData;
|
|
1306
1370
|
/** The type of decoration to apply. */
|
|
1307
1371
|
type?: DecorationTypeWithLiterals;
|
|
1308
1372
|
}
|
|
@@ -1326,6 +1390,14 @@ interface DecorationDataOneOf {
|
|
|
1326
1390
|
underlineData?: boolean | null;
|
|
1327
1391
|
/** Data for a spoiler decoration. */
|
|
1328
1392
|
spoilerData?: SpoilerData;
|
|
1393
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1394
|
+
strikethroughData?: boolean | null;
|
|
1395
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1396
|
+
superscriptData?: boolean | null;
|
|
1397
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1398
|
+
subscriptData?: boolean | null;
|
|
1399
|
+
/** Data for a font family decoration. */
|
|
1400
|
+
fontFamilyData?: FontFamilyData;
|
|
1329
1401
|
}
|
|
1330
1402
|
declare enum DecorationType {
|
|
1331
1403
|
BOLD = "BOLD",
|
|
@@ -1337,10 +1409,14 @@ declare enum DecorationType {
|
|
|
1337
1409
|
LINK = "LINK",
|
|
1338
1410
|
COLOR = "COLOR",
|
|
1339
1411
|
FONT_SIZE = "FONT_SIZE",
|
|
1340
|
-
EXTERNAL = "EXTERNAL"
|
|
1412
|
+
EXTERNAL = "EXTERNAL",
|
|
1413
|
+
STRIKETHROUGH = "STRIKETHROUGH",
|
|
1414
|
+
SUPERSCRIPT = "SUPERSCRIPT",
|
|
1415
|
+
SUBSCRIPT = "SUBSCRIPT",
|
|
1416
|
+
FONT_FAMILY = "FONT_FAMILY"
|
|
1341
1417
|
}
|
|
1342
1418
|
/** @enumType */
|
|
1343
|
-
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
|
1419
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY';
|
|
1344
1420
|
interface AnchorData {
|
|
1345
1421
|
/** The target node's ID. */
|
|
1346
1422
|
anchor?: string;
|
|
@@ -1403,6 +1479,36 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1403
1479
|
url?: string | null;
|
|
1404
1480
|
/** An image for the embedded content. */
|
|
1405
1481
|
image?: V1Media;
|
|
1482
|
+
/** Whether to hide the image. */
|
|
1483
|
+
hideImage?: boolean | null;
|
|
1484
|
+
/** Whether to hide the title. */
|
|
1485
|
+
hideTitle?: boolean | null;
|
|
1486
|
+
/** Whether to hide the price. */
|
|
1487
|
+
hidePrice?: boolean | null;
|
|
1488
|
+
/** Whether to hide the description (Event and Booking). */
|
|
1489
|
+
hideDescription?: boolean | null;
|
|
1490
|
+
/** Whether to hide the date and time (Event). */
|
|
1491
|
+
hideDateTime?: boolean | null;
|
|
1492
|
+
/** Whether to hide the location (Event). */
|
|
1493
|
+
hideLocation?: boolean | null;
|
|
1494
|
+
/** Whether to hide the duration (Booking). */
|
|
1495
|
+
hideDuration?: boolean | null;
|
|
1496
|
+
/** Whether to hide the button. */
|
|
1497
|
+
hideButton?: boolean | null;
|
|
1498
|
+
/** Whether to hide the ribbon. */
|
|
1499
|
+
hideRibbon?: boolean | null;
|
|
1500
|
+
/** Button styling options. */
|
|
1501
|
+
buttonStyles?: ButtonStyles;
|
|
1502
|
+
/** Image styling options. */
|
|
1503
|
+
imageStyles?: ImageStyles;
|
|
1504
|
+
/** Ribbon styling options. */
|
|
1505
|
+
ribbonStyles?: RibbonStyles;
|
|
1506
|
+
/** Card styling options. */
|
|
1507
|
+
cardStyles?: CardStyles;
|
|
1508
|
+
/** Styling for the app embed's container. */
|
|
1509
|
+
containerData?: PluginContainerData;
|
|
1510
|
+
/** Pricing data for embedded Wix App content. */
|
|
1511
|
+
pricingData?: PricingData;
|
|
1406
1512
|
}
|
|
1407
1513
|
/** @oneof */
|
|
1408
1514
|
interface AppEmbedDataAppDataOneOf {
|
|
@@ -1737,6 +1843,13 @@ interface TableData {
|
|
|
1737
1843
|
rowHeader?: boolean | null;
|
|
1738
1844
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1739
1845
|
columnHeader?: boolean | null;
|
|
1846
|
+
/** The spacing between cells in pixels. Defaults to `0`. */
|
|
1847
|
+
cellSpacing?: number | null;
|
|
1848
|
+
/**
|
|
1849
|
+
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
|
|
1850
|
+
* @maxSize 4
|
|
1851
|
+
*/
|
|
1852
|
+
cellPadding?: number[];
|
|
1740
1853
|
}
|
|
1741
1854
|
interface Dimensions {
|
|
1742
1855
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
@@ -1751,6 +1864,12 @@ interface TableCellData {
|
|
|
1751
1864
|
cellStyle?: CellStyle;
|
|
1752
1865
|
/** The cell's border colors. */
|
|
1753
1866
|
borderColors?: BorderColors;
|
|
1867
|
+
/** Defines how many columns the cell spans. Default: 1. */
|
|
1868
|
+
colspan?: number | null;
|
|
1869
|
+
/** Defines how many rows the cell spans. Default: 1. */
|
|
1870
|
+
rowspan?: number | null;
|
|
1871
|
+
/** The cell's border widths. */
|
|
1872
|
+
borderWidths?: BorderWidths;
|
|
1754
1873
|
}
|
|
1755
1874
|
declare enum VerticalAlignment {
|
|
1756
1875
|
/** Top alignment */
|
|
@@ -1979,6 +2098,23 @@ interface LayoutCellData {
|
|
|
1979
2098
|
/** Size of the cell in 12 columns grid. */
|
|
1980
2099
|
colSpan?: number | null;
|
|
1981
2100
|
}
|
|
2101
|
+
interface ShapeData {
|
|
2102
|
+
/** Styling for the shape's container. */
|
|
2103
|
+
containerData?: PluginContainerData;
|
|
2104
|
+
/** Shape file details. */
|
|
2105
|
+
shape?: V1Media;
|
|
2106
|
+
/** Styling for the shape. */
|
|
2107
|
+
styles?: ShapeDataStyles;
|
|
2108
|
+
}
|
|
2109
|
+
interface ShapeDataStyles {
|
|
2110
|
+
/**
|
|
2111
|
+
* Shape fill color as a hexadecimal value.
|
|
2112
|
+
* @format COLOR_HEX
|
|
2113
|
+
*/
|
|
2114
|
+
color?: string | null;
|
|
2115
|
+
/** Map of original color keys to their new color values. */
|
|
2116
|
+
colors?: Record<string, string>;
|
|
2117
|
+
}
|
|
1982
2118
|
interface Metadata {
|
|
1983
2119
|
/** Schema version. */
|
|
1984
2120
|
version?: number;
|
|
@@ -2128,7 +2264,11 @@ interface PostTranslation {
|
|
|
2128
2264
|
*/
|
|
2129
2265
|
language?: string | null;
|
|
2130
2266
|
/**
|
|
2131
|
-
* Post slug.
|
|
2267
|
+
* Post slug.
|
|
2268
|
+
*
|
|
2269
|
+
* The slug is the end of a post's URL that refers to a specific post.
|
|
2270
|
+
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
|
|
2271
|
+
* the slug is `my-post-slug`. The slug is case-sensitive.
|
|
2132
2272
|
* @maxLength 100
|
|
2133
2273
|
*/
|
|
2134
2274
|
slug?: string | null;
|
|
@@ -2675,25 +2815,21 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2675
2815
|
updatedEvent?: EntityUpdatedEvent;
|
|
2676
2816
|
deletedEvent?: EntityDeletedEvent;
|
|
2677
2817
|
actionEvent?: ActionEvent;
|
|
2678
|
-
/**
|
|
2679
|
-
* Unique event ID.
|
|
2680
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2681
|
-
*/
|
|
2818
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2682
2819
|
_id?: string;
|
|
2683
2820
|
/**
|
|
2684
|
-
*
|
|
2685
|
-
*
|
|
2821
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2822
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2686
2823
|
*/
|
|
2687
2824
|
entityFqdn?: string;
|
|
2688
2825
|
/**
|
|
2689
|
-
*
|
|
2690
|
-
*
|
|
2691
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2826
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2827
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2692
2828
|
*/
|
|
2693
2829
|
slug?: string;
|
|
2694
2830
|
/** ID of the entity associated with the event. */
|
|
2695
2831
|
entityId?: string;
|
|
2696
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
2832
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2697
2833
|
eventTime?: Date | null;
|
|
2698
2834
|
/**
|
|
2699
2835
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -2703,12 +2839,8 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2703
2839
|
/** If present, indicates the action that triggered the event. */
|
|
2704
2840
|
originatedFrom?: string | null;
|
|
2705
2841
|
/**
|
|
2706
|
-
* A sequence number
|
|
2707
|
-
*
|
|
2708
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2709
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2710
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2711
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2842
|
+
* 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.
|
|
2843
|
+
* 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.
|
|
2712
2844
|
*/
|
|
2713
2845
|
entityEventSequence?: string | null;
|
|
2714
2846
|
}
|
|
@@ -2734,7 +2866,7 @@ interface EntityUpdatedEvent {
|
|
|
2734
2866
|
currentEntity?: string;
|
|
2735
2867
|
}
|
|
2736
2868
|
interface EntityDeletedEvent {
|
|
2737
|
-
/** Entity that was deleted */
|
|
2869
|
+
/** Entity that was deleted. */
|
|
2738
2870
|
deletedEntity?: string | null;
|
|
2739
2871
|
}
|
|
2740
2872
|
interface ActionEvent {
|
|
@@ -2755,6 +2887,8 @@ interface MessageEnvelope {
|
|
|
2755
2887
|
identity?: IdentificationData;
|
|
2756
2888
|
/** Stringify payload. */
|
|
2757
2889
|
data?: string;
|
|
2890
|
+
/** Details related to the account */
|
|
2891
|
+
accountInfo?: AccountInfo;
|
|
2758
2892
|
}
|
|
2759
2893
|
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2760
2894
|
/**
|
|
@@ -3593,50 +3727,6 @@ interface ConvertRichContentToDraftJsResponse {
|
|
|
3593
3727
|
/** DraftJs content converted from Rich content. */
|
|
3594
3728
|
content?: Record<string, any> | null;
|
|
3595
3729
|
}
|
|
3596
|
-
interface CoverMedia extends CoverMediaMediaOneOf {
|
|
3597
|
-
/** Image url. */
|
|
3598
|
-
image?: string;
|
|
3599
|
-
/** Video url. */
|
|
3600
|
-
video?: string;
|
|
3601
|
-
/**
|
|
3602
|
-
* Is cover media enabled.
|
|
3603
|
-
* Selected by user whether to display cover media on the feed
|
|
3604
|
-
* @deprecated Is cover media enabled.
|
|
3605
|
-
* Selected by user whether to display cover media on the feed
|
|
3606
|
-
* @replacedBy displayed
|
|
3607
|
-
* @targetRemovalDate 2024-06-30
|
|
3608
|
-
*/
|
|
3609
|
-
enabled?: boolean;
|
|
3610
|
-
/** Whether cover media is displayed. */
|
|
3611
|
-
displayed?: boolean;
|
|
3612
|
-
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
|
|
3613
|
-
custom?: boolean;
|
|
3614
|
-
/**
|
|
3615
|
-
* Media alternative text.
|
|
3616
|
-
* @minLength 1
|
|
3617
|
-
* @maxLength 1000
|
|
3618
|
-
*/
|
|
3619
|
-
altText?: string | null;
|
|
3620
|
-
}
|
|
3621
|
-
/** @oneof */
|
|
3622
|
-
interface CoverMediaMediaOneOf {
|
|
3623
|
-
/** Image url. */
|
|
3624
|
-
image?: string;
|
|
3625
|
-
/** Video url. */
|
|
3626
|
-
video?: string;
|
|
3627
|
-
}
|
|
3628
|
-
interface OldBlogMigratedEvent {
|
|
3629
|
-
/**
|
|
3630
|
-
* Instance id of new version of blog
|
|
3631
|
-
* @format GUID
|
|
3632
|
-
*/
|
|
3633
|
-
newBlogInstanceId?: string;
|
|
3634
|
-
/**
|
|
3635
|
-
* Instance id of old version of blog
|
|
3636
|
-
* @format GUID
|
|
3637
|
-
*/
|
|
3638
|
-
oldBlogInstanceId?: string;
|
|
3639
|
-
}
|
|
3640
3730
|
interface BaseEventMetadata {
|
|
3641
3731
|
/**
|
|
3642
3732
|
* App instance ID.
|
|
@@ -3650,27 +3740,25 @@ interface BaseEventMetadata {
|
|
|
3650
3740
|
eventType?: string;
|
|
3651
3741
|
/** The identification type and identity data. */
|
|
3652
3742
|
identity?: IdentificationData;
|
|
3743
|
+
/** Details related to the account */
|
|
3744
|
+
accountInfo?: AccountInfo;
|
|
3653
3745
|
}
|
|
3654
3746
|
interface EventMetadata extends BaseEventMetadata {
|
|
3655
|
-
/**
|
|
3656
|
-
* Unique event ID.
|
|
3657
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3658
|
-
*/
|
|
3747
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3659
3748
|
_id?: string;
|
|
3660
3749
|
/**
|
|
3661
|
-
*
|
|
3662
|
-
*
|
|
3750
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3751
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3663
3752
|
*/
|
|
3664
3753
|
entityFqdn?: string;
|
|
3665
3754
|
/**
|
|
3666
|
-
*
|
|
3667
|
-
*
|
|
3668
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3755
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3756
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3669
3757
|
*/
|
|
3670
3758
|
slug?: string;
|
|
3671
3759
|
/** ID of the entity associated with the event. */
|
|
3672
3760
|
entityId?: string;
|
|
3673
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
3761
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3674
3762
|
eventTime?: Date | null;
|
|
3675
3763
|
/**
|
|
3676
3764
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -3680,12 +3768,8 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
3680
3768
|
/** If present, indicates the action that triggered the event. */
|
|
3681
3769
|
originatedFrom?: string | null;
|
|
3682
3770
|
/**
|
|
3683
|
-
* A sequence number
|
|
3684
|
-
*
|
|
3685
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3686
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3687
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3688
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3771
|
+
* 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.
|
|
3772
|
+
* 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.
|
|
3689
3773
|
*/
|
|
3690
3774
|
entityEventSequence?: string | null;
|
|
3691
3775
|
accountInfo?: AccountInfoMetadata;
|
|
@@ -3864,7 +3948,7 @@ interface GetTotalPostsOptions {
|
|
|
3864
3948
|
* @applicableIdentity APP
|
|
3865
3949
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3866
3950
|
*/
|
|
3867
|
-
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.
|
|
3951
|
+
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>>;
|
|
3868
3952
|
interface GetPostOptions {
|
|
3869
3953
|
/**
|
|
3870
3954
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3889,7 +3973,7 @@ interface GetPostOptions {
|
|
|
3889
3973
|
* @applicableIdentity APP
|
|
3890
3974
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
3891
3975
|
*/
|
|
3892
|
-
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.
|
|
3976
|
+
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>>;
|
|
3893
3977
|
interface GetPostBySlugOptions {
|
|
3894
3978
|
/**
|
|
3895
3979
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3917,7 +4001,7 @@ interface GetPostBySlugOptions {
|
|
|
3917
4001
|
* @applicableIdentity APP
|
|
3918
4002
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
3919
4003
|
*/
|
|
3920
|
-
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}.
|
|
4004
|
+
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>>;
|
|
3921
4005
|
interface ListPostsOptions {
|
|
3922
4006
|
/**
|
|
3923
4007
|
* Whether to return only featured posts.
|
|
@@ -4084,7 +4168,7 @@ interface PostsQueryBuilder {
|
|
|
4084
4168
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
4085
4169
|
* @requiredField query
|
|
4086
4170
|
*/
|
|
4087
|
-
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}.
|
|
4171
|
+
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>>;
|
|
4088
4172
|
interface PostQuerySpec extends QuerySpec {
|
|
4089
4173
|
paging: 'cursor';
|
|
4090
4174
|
wql: [];
|
|
@@ -4136,6 +4220,9 @@ type PostQuery = {
|
|
|
4136
4220
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
4137
4221
|
}[];
|
|
4138
4222
|
};
|
|
4223
|
+
declare const QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
|
|
4224
|
+
declare const Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
|
|
4225
|
+
declare const Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
|
|
4139
4226
|
/**
|
|
4140
4227
|
* Retrieves a post's metrics.
|
|
4141
4228
|
*
|
|
@@ -4149,4 +4236,4 @@ type PostQuery = {
|
|
|
4149
4236
|
*/
|
|
4150
4237
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4151
4238
|
|
|
4152
|
-
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
|
|
4239
|
+
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 };
|