@wix/auto_sdk_blog_posts 1.0.184 → 1.0.186
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 +20 -16
- package/build/cjs/index.js +16 -11
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +35 -23
- package/build/cjs/index.typings.js +6 -6
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +20 -16
- package/build/es/index.mjs +16 -11
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +35 -23
- package/build/es/index.typings.mjs +6 -6
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +20 -16
- package/build/internal/cjs/index.typings.d.ts +35 -23
- package/build/internal/es/index.d.mts +20 -16
- package/build/internal/es/index.typings.d.mts +35 -23
- package/package.json +2 -2
|
@@ -1,37 +1,39 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions,
|
|
3
|
-
export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest,
|
|
2
|
+
import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope, PostQuery, QueryPostsOptions, typedQueryPosts, PostsQueryBuilder } from './index.typings.js';
|
|
3
|
+
export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest, GetPostsSort, GetPostsSortWithLiterals, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListItemNodeData, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, Order, OrderWithLiterals, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlacementWithLiterals, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, Post, PostCategoriesUpdated, PostCount, PostCountInfo, PostCountPerMonth, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostQuerySpec, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, PricingData, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsRequestOrderWithLiterals, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RestoreInfo, RibbonStyles, RichContent, Scaling, ScalingWithLiterals, ScheduledPostPublished, SectionDivider, SeoSchema, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewPostResponse, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia, utils } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
|
|
6
6
|
interface QueryPostCountStatsSignature {
|
|
7
7
|
/**
|
|
8
8
|
* Retrieves the number of published posts per month within a specified time range.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
* The
|
|
12
|
-
*
|
|
13
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
*
|
|
11
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
12
|
+
*
|
|
13
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
14
|
+
*
|
|
15
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
16
|
+
* @param - Options specifying time frame, sort, and filter.
|
|
16
17
|
* @returns Get Blog Post Count Stats response
|
|
17
18
|
*/
|
|
18
|
-
(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`,
|
|
19
|
+
(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 2>>;
|
|
19
20
|
}
|
|
20
21
|
declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature;
|
|
21
22
|
interface GetTotalPostsSignature {
|
|
22
23
|
/**
|
|
23
24
|
* Retrieves the total amount of published posts of the blog.
|
|
25
|
+
* @param - Language Options.
|
|
24
26
|
*/
|
|
25
|
-
(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`,
|
|
27
|
+
(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 0>>;
|
|
26
28
|
}
|
|
27
29
|
declare function getPost$1(httpClient: HttpClient): GetPostSignature;
|
|
28
30
|
interface GetPostSignature {
|
|
29
31
|
/**
|
|
30
32
|
* Retrieves a post by the specified ID.
|
|
31
33
|
* @param - Post ID.
|
|
32
|
-
* @
|
|
34
|
+
* @param - Options specifying which fields to return.
|
|
33
35
|
*/
|
|
34
|
-
(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
36
|
+
(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`, 5>>;
|
|
35
37
|
}
|
|
36
38
|
declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
|
|
37
39
|
interface GetPostBySlugSignature {
|
|
@@ -43,8 +45,9 @@ interface GetPostBySlugSignature {
|
|
|
43
45
|
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
|
44
46
|
* unless specified otherwise.
|
|
45
47
|
* @param - Slug of the post to retrieve.
|
|
48
|
+
* @param - Options specifying which fields to return.
|
|
46
49
|
*/
|
|
47
|
-
(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`,
|
|
50
|
+
(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`, 5>>;
|
|
48
51
|
}
|
|
49
52
|
declare function listPosts$1(httpClient: HttpClient): ListPostsSignature;
|
|
50
53
|
interface ListPostsSignature {
|
|
@@ -55,8 +58,9 @@ interface ListPostsSignature {
|
|
|
55
58
|
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
56
59
|
* - `paging.limit` is `50`.
|
|
57
60
|
* - `paging.offset` is `0`.
|
|
61
|
+
* @param - Sort, filter, and paging options.
|
|
58
62
|
*/
|
|
59
|
-
(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`,
|
|
63
|
+
(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`, 4>>;
|
|
60
64
|
}
|
|
61
65
|
declare function getPostMetrics$1(httpClient: HttpClient): GetPostMetricsSignature;
|
|
62
66
|
interface GetPostMetricsSignature {
|
|
@@ -66,7 +70,7 @@ interface GetPostMetricsSignature {
|
|
|
66
70
|
* A post's metrics include the comments, likes, and views the post receives.
|
|
67
71
|
* @param - Post ID to retrieve metrics for.
|
|
68
72
|
*/
|
|
69
|
-
(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`,
|
|
73
|
+
(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 1>>;
|
|
70
74
|
}
|
|
71
75
|
declare const onPostLiked$1: EventDefinition<PostLikedEnvelope, "wix.blog.v3.post_liked">;
|
|
72
76
|
declare const onPostUnliked$1: EventDefinition<PostUnlikedEnvelope, "wix.blog.v3.post_unliked">;
|
|
@@ -102,4 +106,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
|
|
|
102
106
|
*/
|
|
103
107
|
declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
|
|
104
108
|
|
|
105
|
-
export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse,
|
|
109
|
+
export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostQuery, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
|
|
@@ -4786,19 +4786,20 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
4786
4786
|
/**
|
|
4787
4787
|
* Retrieves the number of published posts per month within a specified time range.
|
|
4788
4788
|
*
|
|
4789
|
-
*
|
|
4790
|
-
* The
|
|
4791
|
-
*
|
|
4792
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
4793
|
-
*
|
|
4794
|
-
*
|
|
4789
|
+
*
|
|
4790
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
4791
|
+
*
|
|
4792
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
4793
|
+
*
|
|
4794
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
4795
4795
|
* @public
|
|
4796
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
4796
4797
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4797
4798
|
* @applicableIdentity APP
|
|
4798
4799
|
* @returns Get Blog Post Count Stats response
|
|
4799
4800
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
|
4800
4801
|
*/
|
|
4801
|
-
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`,
|
|
4802
|
+
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 2>>;
|
|
4802
4803
|
interface QueryPostCountStatsOptions {
|
|
4803
4804
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
4804
4805
|
rangeStart?: Date | null;
|
|
@@ -4833,11 +4834,12 @@ interface QueryPostCountStatsOptions {
|
|
|
4833
4834
|
/**
|
|
4834
4835
|
* Retrieves the total amount of published posts of the blog.
|
|
4835
4836
|
* @public
|
|
4837
|
+
* @param options - Language Options.
|
|
4836
4838
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4837
4839
|
* @applicableIdentity APP
|
|
4838
4840
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
4839
4841
|
*/
|
|
4840
|
-
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`,
|
|
4842
|
+
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 0>>;
|
|
4841
4843
|
interface GetTotalPostsOptions {
|
|
4842
4844
|
/**
|
|
4843
4845
|
* Language filter.
|
|
@@ -4853,12 +4855,12 @@ interface GetTotalPostsOptions {
|
|
|
4853
4855
|
* @param postId - Post ID.
|
|
4854
4856
|
* @public
|
|
4855
4857
|
* @requiredField postId
|
|
4858
|
+
* @param options - Options specifying which fields to return.
|
|
4856
4859
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4857
4860
|
* @applicableIdentity APP
|
|
4858
|
-
* @returns Retrieved post info.
|
|
4859
4861
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4860
4862
|
*/
|
|
4861
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4863
|
+
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`, 5>>;
|
|
4862
4864
|
interface GetPostOptions {
|
|
4863
4865
|
/**
|
|
4864
4866
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4878,11 +4880,12 @@ interface GetPostOptions {
|
|
|
4878
4880
|
* @param slug - Slug of the post to retrieve.
|
|
4879
4881
|
* @public
|
|
4880
4882
|
* @requiredField slug
|
|
4883
|
+
* @param options - Options specifying which fields to return.
|
|
4881
4884
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4882
4885
|
* @applicableIdentity APP
|
|
4883
4886
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
4884
4887
|
*/
|
|
4885
|
-
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`,
|
|
4888
|
+
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`, 5>>;
|
|
4886
4889
|
interface GetPostBySlugOptions {
|
|
4887
4890
|
/**
|
|
4888
4891
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4905,11 +4908,12 @@ interface GetPostBySlugOptions {
|
|
|
4905
4908
|
* - `paging.limit` is `50`.
|
|
4906
4909
|
* - `paging.offset` is `0`.
|
|
4907
4910
|
* @public
|
|
4911
|
+
* @param options - Sort, filter, and paging options.
|
|
4908
4912
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4909
4913
|
* @applicableIdentity APP
|
|
4910
4914
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
4911
4915
|
*/
|
|
4912
|
-
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`,
|
|
4916
|
+
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`, 4>>;
|
|
4913
4917
|
interface ListPostsOptions {
|
|
4914
4918
|
/**
|
|
4915
4919
|
* Whether to return only featured posts.
|
|
@@ -4975,18 +4979,26 @@ interface ListPostsOptions {
|
|
|
4975
4979
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4976
4980
|
}
|
|
4977
4981
|
/**
|
|
4978
|
-
*
|
|
4982
|
+
* Creates a query to retrieve a list of posts.
|
|
4979
4983
|
*
|
|
4980
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4981
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4982
|
-
* - `paging.limit` is `50`.
|
|
4983
|
-
* - `paging.offset` is `0`.
|
|
4984
4984
|
*
|
|
4985
|
-
*
|
|
4986
|
-
*
|
|
4987
|
-
*
|
|
4988
|
-
*
|
|
4985
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4986
|
+
*
|
|
4987
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4988
|
+
*
|
|
4989
|
+
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
4990
|
+
*
|
|
4991
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4992
|
+
* + `limit(50)`
|
|
4993
|
+
* + `descending('firstPublishedDate')`
|
|
4994
|
+
*
|
|
4995
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4996
|
+
*
|
|
4997
|
+
* To learn how to query posts, refer to the table below.
|
|
4998
|
+
*
|
|
4999
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
|
|
4989
5000
|
* @public
|
|
5001
|
+
* @param options - Options specifying which fields to return.
|
|
4990
5002
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4991
5003
|
* @applicableIdentity APP
|
|
4992
5004
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -5128,7 +5140,7 @@ interface PostsQueryBuilder {
|
|
|
5128
5140
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
5129
5141
|
* @requiredField query
|
|
5130
5142
|
*/
|
|
5131
|
-
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`,
|
|
5143
|
+
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`, 4>>;
|
|
5132
5144
|
interface PostQuerySpec extends QuerySpec {
|
|
5133
5145
|
paging: 'cursor';
|
|
5134
5146
|
wql: [
|
|
@@ -5325,6 +5337,6 @@ declare const utils: {
|
|
|
5325
5337
|
* @applicableIdentity APP
|
|
5326
5338
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
|
5327
5339
|
*/
|
|
5328
|
-
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`,
|
|
5340
|
+
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 1>>;
|
|
5329
5341
|
|
|
5330
5342
|
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, 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 CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, 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 DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, 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 GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, 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 PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, 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, 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 SectionDivider, type SeoSchema, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, 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 TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, 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, utils };
|
|
@@ -1,37 +1,39 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions,
|
|
3
|
-
export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest,
|
|
2
|
+
import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope, PostQuery, QueryPostsOptions, typedQueryPosts, PostsQueryBuilder } from './index.typings.mjs';
|
|
3
|
+
export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest, GetPostsSort, GetPostsSortWithLiterals, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListItemNodeData, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, Order, OrderWithLiterals, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlacementWithLiterals, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, Post, PostCategoriesUpdated, PostCount, PostCountInfo, PostCountPerMonth, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostQuerySpec, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, PricingData, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsRequestOrderWithLiterals, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RestoreInfo, RibbonStyles, RichContent, Scaling, ScalingWithLiterals, ScheduledPostPublished, SectionDivider, SeoSchema, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewPostResponse, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia, utils } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
|
|
6
6
|
interface QueryPostCountStatsSignature {
|
|
7
7
|
/**
|
|
8
8
|
* Retrieves the number of published posts per month within a specified time range.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
* The
|
|
12
|
-
*
|
|
13
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
*
|
|
11
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
12
|
+
*
|
|
13
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
14
|
+
*
|
|
15
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
16
|
+
* @param - Options specifying time frame, sort, and filter.
|
|
16
17
|
* @returns Get Blog Post Count Stats response
|
|
17
18
|
*/
|
|
18
|
-
(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`,
|
|
19
|
+
(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 2>>;
|
|
19
20
|
}
|
|
20
21
|
declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature;
|
|
21
22
|
interface GetTotalPostsSignature {
|
|
22
23
|
/**
|
|
23
24
|
* Retrieves the total amount of published posts of the blog.
|
|
25
|
+
* @param - Language Options.
|
|
24
26
|
*/
|
|
25
|
-
(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`,
|
|
27
|
+
(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 0>>;
|
|
26
28
|
}
|
|
27
29
|
declare function getPost$1(httpClient: HttpClient): GetPostSignature;
|
|
28
30
|
interface GetPostSignature {
|
|
29
31
|
/**
|
|
30
32
|
* Retrieves a post by the specified ID.
|
|
31
33
|
* @param - Post ID.
|
|
32
|
-
* @
|
|
34
|
+
* @param - Options specifying which fields to return.
|
|
33
35
|
*/
|
|
34
|
-
(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
36
|
+
(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`, 5>>;
|
|
35
37
|
}
|
|
36
38
|
declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
|
|
37
39
|
interface GetPostBySlugSignature {
|
|
@@ -43,8 +45,9 @@ interface GetPostBySlugSignature {
|
|
|
43
45
|
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
|
44
46
|
* unless specified otherwise.
|
|
45
47
|
* @param - Slug of the post to retrieve.
|
|
48
|
+
* @param - Options specifying which fields to return.
|
|
46
49
|
*/
|
|
47
|
-
(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`,
|
|
50
|
+
(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`, 5>>;
|
|
48
51
|
}
|
|
49
52
|
declare function listPosts$1(httpClient: HttpClient): ListPostsSignature;
|
|
50
53
|
interface ListPostsSignature {
|
|
@@ -55,8 +58,9 @@ interface ListPostsSignature {
|
|
|
55
58
|
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
56
59
|
* - `paging.limit` is `50`.
|
|
57
60
|
* - `paging.offset` is `0`.
|
|
61
|
+
* @param - Sort, filter, and paging options.
|
|
58
62
|
*/
|
|
59
|
-
(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`,
|
|
63
|
+
(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`, 4>>;
|
|
60
64
|
}
|
|
61
65
|
declare function getPostMetrics$1(httpClient: HttpClient): GetPostMetricsSignature;
|
|
62
66
|
interface GetPostMetricsSignature {
|
|
@@ -66,7 +70,7 @@ interface GetPostMetricsSignature {
|
|
|
66
70
|
* A post's metrics include the comments, likes, and views the post receives.
|
|
67
71
|
* @param - Post ID to retrieve metrics for.
|
|
68
72
|
*/
|
|
69
|
-
(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`,
|
|
73
|
+
(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 1>>;
|
|
70
74
|
}
|
|
71
75
|
declare const onPostLiked$1: EventDefinition<PostLikedEnvelope, "wix.blog.v3.post_liked">;
|
|
72
76
|
declare const onPostUnliked$1: EventDefinition<PostUnlikedEnvelope, "wix.blog.v3.post_unliked">;
|
|
@@ -102,4 +106,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
|
|
|
102
106
|
*/
|
|
103
107
|
declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
|
|
104
108
|
|
|
105
|
-
export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse,
|
|
109
|
+
export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostQuery, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
|
|
@@ -4786,19 +4786,20 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
4786
4786
|
/**
|
|
4787
4787
|
* Retrieves the number of published posts per month within a specified time range.
|
|
4788
4788
|
*
|
|
4789
|
-
*
|
|
4790
|
-
* The
|
|
4791
|
-
*
|
|
4792
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
4793
|
-
*
|
|
4794
|
-
*
|
|
4789
|
+
*
|
|
4790
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
4791
|
+
*
|
|
4792
|
+
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
|
4793
|
+
*
|
|
4794
|
+
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
|
4795
4795
|
* @public
|
|
4796
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
4796
4797
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4797
4798
|
* @applicableIdentity APP
|
|
4798
4799
|
* @returns Get Blog Post Count Stats response
|
|
4799
4800
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
|
4800
4801
|
*/
|
|
4801
|
-
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`,
|
|
4802
|
+
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 2>>;
|
|
4802
4803
|
interface QueryPostCountStatsOptions {
|
|
4803
4804
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
|
4804
4805
|
rangeStart?: Date | null;
|
|
@@ -4833,11 +4834,12 @@ interface QueryPostCountStatsOptions {
|
|
|
4833
4834
|
/**
|
|
4834
4835
|
* Retrieves the total amount of published posts of the blog.
|
|
4835
4836
|
* @public
|
|
4837
|
+
* @param options - Language Options.
|
|
4836
4838
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4837
4839
|
* @applicableIdentity APP
|
|
4838
4840
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
4839
4841
|
*/
|
|
4840
|
-
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`,
|
|
4842
|
+
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 0>>;
|
|
4841
4843
|
interface GetTotalPostsOptions {
|
|
4842
4844
|
/**
|
|
4843
4845
|
* Language filter.
|
|
@@ -4853,12 +4855,12 @@ interface GetTotalPostsOptions {
|
|
|
4853
4855
|
* @param postId - Post ID.
|
|
4854
4856
|
* @public
|
|
4855
4857
|
* @requiredField postId
|
|
4858
|
+
* @param options - Options specifying which fields to return.
|
|
4856
4859
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4857
4860
|
* @applicableIdentity APP
|
|
4858
|
-
* @returns Retrieved post info.
|
|
4859
4861
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4860
4862
|
*/
|
|
4861
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4863
|
+
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`, 5>>;
|
|
4862
4864
|
interface GetPostOptions {
|
|
4863
4865
|
/**
|
|
4864
4866
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4878,11 +4880,12 @@ interface GetPostOptions {
|
|
|
4878
4880
|
* @param slug - Slug of the post to retrieve.
|
|
4879
4881
|
* @public
|
|
4880
4882
|
* @requiredField slug
|
|
4883
|
+
* @param options - Options specifying which fields to return.
|
|
4881
4884
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4882
4885
|
* @applicableIdentity APP
|
|
4883
4886
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
4884
4887
|
*/
|
|
4885
|
-
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`,
|
|
4888
|
+
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`, 5>>;
|
|
4886
4889
|
interface GetPostBySlugOptions {
|
|
4887
4890
|
/**
|
|
4888
4891
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4905,11 +4908,12 @@ interface GetPostBySlugOptions {
|
|
|
4905
4908
|
* - `paging.limit` is `50`.
|
|
4906
4909
|
* - `paging.offset` is `0`.
|
|
4907
4910
|
* @public
|
|
4911
|
+
* @param options - Sort, filter, and paging options.
|
|
4908
4912
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4909
4913
|
* @applicableIdentity APP
|
|
4910
4914
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
4911
4915
|
*/
|
|
4912
|
-
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`,
|
|
4916
|
+
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`, 4>>;
|
|
4913
4917
|
interface ListPostsOptions {
|
|
4914
4918
|
/**
|
|
4915
4919
|
* Whether to return only featured posts.
|
|
@@ -4975,18 +4979,26 @@ interface ListPostsOptions {
|
|
|
4975
4979
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4976
4980
|
}
|
|
4977
4981
|
/**
|
|
4978
|
-
*
|
|
4982
|
+
* Creates a query to retrieve a list of posts.
|
|
4979
4983
|
*
|
|
4980
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4981
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4982
|
-
* - `paging.limit` is `50`.
|
|
4983
|
-
* - `paging.offset` is `0`.
|
|
4984
4984
|
*
|
|
4985
|
-
*
|
|
4986
|
-
*
|
|
4987
|
-
*
|
|
4988
|
-
*
|
|
4985
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4986
|
+
*
|
|
4987
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4988
|
+
*
|
|
4989
|
+
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
4990
|
+
*
|
|
4991
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4992
|
+
* + `limit(50)`
|
|
4993
|
+
* + `descending('firstPublishedDate')`
|
|
4994
|
+
*
|
|
4995
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4996
|
+
*
|
|
4997
|
+
* To learn how to query posts, refer to the table below.
|
|
4998
|
+
*
|
|
4999
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
|
|
4989
5000
|
* @public
|
|
5001
|
+
* @param options - Options specifying which fields to return.
|
|
4990
5002
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4991
5003
|
* @applicableIdentity APP
|
|
4992
5004
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -5128,7 +5140,7 @@ interface PostsQueryBuilder {
|
|
|
5128
5140
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
5129
5141
|
* @requiredField query
|
|
5130
5142
|
*/
|
|
5131
|
-
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`,
|
|
5143
|
+
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`, 4>>;
|
|
5132
5144
|
interface PostQuerySpec extends QuerySpec {
|
|
5133
5145
|
paging: 'cursor';
|
|
5134
5146
|
wql: [
|
|
@@ -5325,6 +5337,6 @@ declare const utils: {
|
|
|
5325
5337
|
* @applicableIdentity APP
|
|
5326
5338
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
|
5327
5339
|
*/
|
|
5328
|
-
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`,
|
|
5340
|
+
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 1>>;
|
|
5329
5341
|
|
|
5330
5342
|
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, 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 CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, 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 DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, 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 GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, 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 PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, 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, 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 SectionDivider, type SeoSchema, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, 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 TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, 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, utils };
|