@wix/auto_sdk_blog_posts - npm Package Compare versions

Comparing version 1.0.15 to 1.0.16

build/cjs/src/blog-v3-post-posts.context.d.ts

@@ -37,2 +37,2 @@ import { queryPostCountStats as publicQueryPostCountStats, getTotalPosts as publicGetTotalPosts, getPost as publicGetPost, getPostBySlug as publicGetPostBySlug, listPosts as publicListPosts, queryPosts as publicQueryPosts, getPostMetrics as publicGetPostMetrics } from './blog-v3-post-posts.public.js';
 export { NodeType, WidthType, PluginContainerDataAlignment, Type, Target, TextAlignment, LineStyle, Width, Alignment, ViewMode, LayoutType, Orientation, Crop, ThumbnailsAlignment, GIFType, Source, Position, MapType, ViewRole, VoteRole, PollLayoutType, PollLayoutDirection, BackgroundType, DecorationType, FontType, AppType, InitialExpandedItems, Direction, VerticalAlignment, NullValue, ModerationStatusStatus, QueryPublicationsCountStatsRequestOrder, Order, WebhookIdentityType, GetPostTemplatesSort, Origin, Status, Field, PostFieldField, GetPostsSort, SortOrder, } from './blog-v3-post-posts.universal.js';
-export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, PostNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';
+export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';

build/cjs/src/blog-v3-post-posts.http.d.ts

@@ -5,8 +5,8 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -37,18 +37,20 @@ export declare function queryPostCountStats(payload: object): RequestOptionsFactory<any>;
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -55,0 +57,0 @@ export declare function queryPosts(payload: object): RequestOptionsFactory<any>;

build/cjs/src/blog-v3-post-posts.http.js

@@ -381,8 +381,8 @@ "use strict";
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -747,18 +747,20 @@ function queryPostCountStats(payload) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -765,0 +767,0 @@ function queryPosts(payload) {

build/cjs/src/blog-v3-post-posts.public.d.ts

 import { EventDefinition, HttpClient } from '@wix/sdk-types';
-import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostNonNullableFields, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
+import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostResponse, GetPostResponseNonNullableFields, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
 export declare const __metadata: {
@@ -11,8 +11,9 @@ PACKAGE_NAME: string;
      *
-     * The time range is set 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 always ends on the last day of the month.
-     * > Note: If there are no published posts in a month within the time range, 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.
+     *
+     * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+     *
+     * 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.
+     *
+     * >**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.
+     * @param - Options specifying time frame, sort, and filter.
      * @returns Get Blog Post Count Stats response
@@ -26,2 +27,3 @@ */
      * Retrieves the total amount of published posts of the blog.
+     * @param - Language Options.
      */
@@ -35,5 +37,5 @@ (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
      * @param - Post ID.
-     * @returns Retrieved post info.
+     * @param - Options specifying which fields to return.
      */
-    (postId: string, options?: GetPostOptions | undefined): Promise<Post & PostNonNullableFields>;
+    (postId: string, options?: GetPostOptions | undefined): Promise<GetPostResponse & GetPostResponseNonNullableFields>;
 }
@@ -50,2 +52,3 @@ export declare function getPostBySlug(httpClient: HttpClient): GetPostBySlugSignature;
      * @param - Slug of the post to retrieve.
+     * @param - Options specifying which fields to return.
      */
@@ -63,2 +66,3 @@ (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
      * - `paging.offset` is `0`.
+     * @param - Sort, filter, and paging options.
      */
@@ -70,18 +74,21 @@ (options?: ListPostsOptions | undefined): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
     /**
-     * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of posts.
      *
-     * Query Posts runs with these defaults, which you can override:
-     * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
-     * - `paging.limit` is `50`.
-     * - `paging.offset` is `0`.
      *
-     * For field support for filters and sorting, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
      *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
-     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
-     * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
-     * For a detailed list of supported filters and sortable fields, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+     *
+     * 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.
+     *
+     * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+     * + `limit(50)`
+     * + `descending('firstPublishedDate')`
+     *
+     * Note that the default limit is `'50'`, but the max limit is `'100'`.
+     *
+     * To learn how to query posts, refer to the table below.
+     *
+     * 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`.
+     * @param - Options specifying which fields to return.
      */
@@ -105,2 +112,2 @@ (options?: QueryPostsOptions | undefined): PostsQueryBuilder;
 export declare const onPostUpdated: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
-export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostNonNullableFields, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';
+export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';

build/cjs/src/blog-v3-post-posts.public.js

@@ -127,3 +127,3 @@ "use strict";
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostDeleted = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_deleted', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -197,3 +197,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostLiked = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_liked', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -204,3 +204,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostUnliked = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_unliked', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -211,3 +211,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostUpdated = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_updated', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -281,3 +281,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 var blog_v3_post_posts_universal_js_2 = require("./blog-v3-post-posts.universal.js");
@@ -284,0 +284,0 @@ Object.defineProperty(exports, "Alignment", { enumerable: true, get: function () { return blog_v3_post_posts_universal_js_2.Alignment; } });

build/cjs/src/blog-v3-post-posts.universal.js

@@ -521,10 +521,11 @@ "use strict";
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  * @public
  * @documentationMaturity preview
+ * @param options - Options specifying time frame, sort, and filter.
  * @permissionId BLOG.READ-PUBLICATION
@@ -551,3 +552,3 @@ * @permissionScope Read Blog
         timeZone: options?.timeZone,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.queryPostCountStats(payload);
@@ -558,3 +559,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data, []);
     }
@@ -582,2 +583,3 @@ catch (err) {
  * @documentationMaturity preview
+ * @param options - Language Options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -597,5 +599,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[1];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-        language: options?.language,
-    });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ language: options?.language }, []);
     const reqOpts = ambassadorWixBlogV3Post.getTotalPosts(payload);
@@ -606,3 +606,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data, []);
     }
@@ -625,2 +625,3 @@ catch (err) {
  * @requiredField postId
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -635,3 +636,2 @@ * @permissionScope Read Blog
  * @applicableIdentity VISITOR
- * @returns Retrieved post info.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
@@ -642,6 +642,3 @@ */
     const { httpClient, sideEffects } = arguments[2];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-        postId: postId,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ postId: postId, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPost(payload);
@@ -673,3 +670,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]))?.post;
+        ]), ['post.rich_content']);
     }
@@ -700,2 +697,3 @@ catch (err) {
  * @requiredField slug
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -715,6 +713,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[2];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-        slug: slug,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ slug: slug, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostBySlug(payload);
@@ -746,3 +741,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['post.rich_content']);
     }
@@ -768,2 +763,3 @@ catch (err) {
  * @public
+ * @param options - Sort, filter, and paging options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -793,3 +789,3 @@ * @permissionScope Read Blog
         fieldsets: options?.fieldsets,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.listPosts(payload);
@@ -821,3 +817,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['posts.rich_content']);
     }
@@ -846,19 +842,22 @@ catch (err) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  * @public
+ * @param options - Options specifying which fields to return.
  * @permissionScope Read Blog
@@ -897,6 +896,3 @@ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
             const args = [query, options];
-            return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-                ...args?.[1],
-                query: args?.[0],
-            });
+            return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ ...args?.[1], query: args?.[0] }, []);
         },
@@ -925,3 +921,3 @@ responseTransformer: ({ data }) => {
                 },
-            ]));
+            ]), ['posts.rich_content']);
             return {
@@ -966,3 +962,3 @@ items: transformedData?.posts,
     const { httpClient, sideEffects } = arguments[1];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ postId: postId });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ postId: postId }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostMetrics(payload);
@@ -973,3 +969,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data, []);
     }
@@ -976,0 +972,0 @@ catch (err) {

build/es/src/blog-v3-post-posts.context.d.ts

@@ -37,2 +37,2 @@ import { queryPostCountStats as publicQueryPostCountStats, getTotalPosts as publicGetTotalPosts, getPost as publicGetPost, getPostBySlug as publicGetPostBySlug, listPosts as publicListPosts, queryPosts as publicQueryPosts, getPostMetrics as publicGetPostMetrics } from './blog-v3-post-posts.public.js';
 export { NodeType, WidthType, PluginContainerDataAlignment, Type, Target, TextAlignment, LineStyle, Width, Alignment, ViewMode, LayoutType, Orientation, Crop, ThumbnailsAlignment, GIFType, Source, Position, MapType, ViewRole, VoteRole, PollLayoutType, PollLayoutDirection, BackgroundType, DecorationType, FontType, AppType, InitialExpandedItems, Direction, VerticalAlignment, NullValue, ModerationStatusStatus, QueryPublicationsCountStatsRequestOrder, Order, WebhookIdentityType, GetPostTemplatesSort, Origin, Status, Field, PostFieldField, GetPostsSort, SortOrder, } from './blog-v3-post-posts.universal.js';
-export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, PostNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';
+export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';

build/es/src/blog-v3-post-posts.http.d.ts

@@ -5,8 +5,8 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -37,18 +37,20 @@ export declare function queryPostCountStats(payload: object): RequestOptionsFactory<any>;
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -55,0 +57,0 @@ export declare function queryPosts(payload: object): RequestOptionsFactory<any>;

build/es/src/blog-v3-post-posts.http.js

@@ -378,8 +378,8 @@ import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -739,18 +739,20 @@ export function queryPostCountStats(payload) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -757,0 +759,0 @@ export function queryPosts(payload) {

build/es/src/blog-v3-post-posts.public.d.ts

 import { EventDefinition, HttpClient } from '@wix/sdk-types';
-import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostNonNullableFields, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
+import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostResponse, GetPostResponseNonNullableFields, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
 export declare const __metadata: {
@@ -11,8 +11,9 @@ PACKAGE_NAME: string;
      *
-     * The time range is set 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 always ends on the last day of the month.
-     * > Note: If there are no published posts in a month within the time range, 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.
+     *
+     * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+     *
+     * 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.
+     *
+     * >**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.
+     * @param - Options specifying time frame, sort, and filter.
      * @returns Get Blog Post Count Stats response
@@ -26,2 +27,3 @@ */
      * Retrieves the total amount of published posts of the blog.
+     * @param - Language Options.
      */
@@ -35,5 +37,5 @@ (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
      * @param - Post ID.
-     * @returns Retrieved post info.
+     * @param - Options specifying which fields to return.
      */
-    (postId: string, options?: GetPostOptions | undefined): Promise<Post & PostNonNullableFields>;
+    (postId: string, options?: GetPostOptions | undefined): Promise<GetPostResponse & GetPostResponseNonNullableFields>;
 }
@@ -50,2 +52,3 @@ export declare function getPostBySlug(httpClient: HttpClient): GetPostBySlugSignature;
      * @param - Slug of the post to retrieve.
+     * @param - Options specifying which fields to return.
      */
@@ -63,2 +66,3 @@ (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
      * - `paging.offset` is `0`.
+     * @param - Sort, filter, and paging options.
      */
@@ -70,18 +74,21 @@ (options?: ListPostsOptions | undefined): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
     /**
-     * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of posts.
      *
-     * Query Posts runs with these defaults, which you can override:
-     * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
-     * - `paging.limit` is `50`.
-     * - `paging.offset` is `0`.
      *
-     * For field support for filters and sorting, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
      *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
-     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
-     * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
-     * For a detailed list of supported filters and sortable fields, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+     *
+     * 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.
+     *
+     * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+     * + `limit(50)`
+     * + `descending('firstPublishedDate')`
+     *
+     * Note that the default limit is `'50'`, but the max limit is `'100'`.
+     *
+     * To learn how to query posts, refer to the table below.
+     *
+     * 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`.
+     * @param - Options specifying which fields to return.
      */
@@ -105,2 +112,2 @@ (options?: QueryPostsOptions | undefined): PostsQueryBuilder;
 export declare const onPostUpdated: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
-export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostNonNullableFields, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';
+export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';

build/es/src/blog-v3-post-posts.public.js

@@ -116,3 +116,3 @@ import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostDeleted = EventDefinition('wix.blog.v3.post_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -186,3 +186,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostLiked = EventDefinition('wix.blog.v3.post_liked', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -193,3 +193,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostUnliked = EventDefinition('wix.blog.v3.post_unliked', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -200,3 +200,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostUpdated = EventDefinition('wix.blog.v3.post_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -270,4 +270,4 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export { Alignment, AppType, BackgroundType, Crop, DecorationType, Direction, Field, FontType, GIFType, GetPostTemplatesSort, GetPostsSort, InitialExpandedItems, LayoutType, LineStyle, MapType, ModerationStatusStatus, NodeType, NullValue, Order, Orientation, Origin, PluginContainerDataAlignment, PollLayoutDirection, PollLayoutType, Position, PostFieldField, QueryPublicationsCountStatsRequestOrder, SortOrder, Source, Status, Target, TextAlignment, ThumbnailsAlignment, Type, VerticalAlignment, ViewMode, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, } from './blog-v3-post-posts.universal.js';
 //# sourceMappingURL=blog-v3-post-posts.public.js.map

build/es/src/blog-v3-post-posts.universal.js

@@ -495,10 +495,11 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  * @public
  * @documentationMaturity preview
+ * @param options - Options specifying time frame, sort, and filter.
  * @permissionId BLOG.READ-PUBLICATION
@@ -525,3 +526,3 @@ * @permissionScope Read Blog
         timeZone: options?.timeZone,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.queryPostCountStats(payload);
@@ -532,3 +533,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
+        return renameKeysFromRESTResponseToSDKResponse(result.data, []);
     }
@@ -555,2 +556,3 @@ catch (err) {
  * @documentationMaturity preview
+ * @param options - Language Options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -570,5 +572,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        language: options?.language,
-    });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ language: options?.language }, []);
     const reqOpts = ambassadorWixBlogV3Post.getTotalPosts(payload);
@@ -579,3 +579,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
+        return renameKeysFromRESTResponseToSDKResponse(result.data, []);
     }
@@ -597,2 +597,3 @@ catch (err) {
  * @requiredField postId
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -607,3 +608,2 @@ * @permissionScope Read Blog
  * @applicableIdentity VISITOR
- * @returns Retrieved post info.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
@@ -614,6 +614,3 @@ */
     const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        postId: postId,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPost(payload);
@@ -645,3 +642,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]))?.post;
+        ]), ['post.rich_content']);
     }
@@ -671,2 +668,3 @@ catch (err) {
  * @requiredField slug
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -686,6 +684,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        slug: slug,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ slug: slug, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostBySlug(payload);
@@ -717,3 +712,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['post.rich_content']);
     }
@@ -738,2 +733,3 @@ catch (err) {
  * @public
+ * @param options - Sort, filter, and paging options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -763,3 +759,3 @@ * @permissionScope Read Blog
         fieldsets: options?.fieldsets,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.listPosts(payload);
@@ -791,3 +787,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['posts.rich_content']);
     }
@@ -815,19 +811,22 @@ catch (err) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  * @public
+ * @param options - Options specifying which fields to return.
  * @permissionScope Read Blog
@@ -866,6 +865,3 @@ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
             const args = [query, options];
-            return renameKeysFromSDKRequestToRESTRequest({
-                ...args?.[1],
-                query: args?.[0],
-            });
+            return renameKeysFromSDKRequestToRESTRequest({ ...args?.[1], query: args?.[0] }, []);
         },
@@ -894,3 +890,3 @@ responseTransformer: ({ data }) => {
                 },
-            ]));
+            ]), ['posts.rich_content']);
             return {
@@ -934,3 +930,3 @@ items: transformedData?.posts,
     const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostMetrics(payload);
@@ -941,3 +937,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
+        return renameKeysFromRESTResponseToSDKResponse(result.data, []);
     }
@@ -944,0 +940,0 @@ catch (err) {

build/internal/cjs/src/blog-v3-post-posts.context.d.ts

@@ -37,2 +37,2 @@ import { queryPostCountStats as publicQueryPostCountStats, getTotalPosts as publicGetTotalPosts, getPost as publicGetPost, getPostBySlug as publicGetPostBySlug, listPosts as publicListPosts, queryPosts as publicQueryPosts, getPostMetrics as publicGetPostMetrics } from './blog-v3-post-posts.public.js';
 export { NodeType, WidthType, PluginContainerDataAlignment, Type, Target, TextAlignment, LineStyle, Width, Alignment, ViewMode, LayoutType, Orientation, Crop, ThumbnailsAlignment, GIFType, Source, Position, MapType, ViewRole, VoteRole, PollLayoutType, PollLayoutDirection, BackgroundType, DecorationType, FontType, AppType, InitialExpandedItems, Direction, VerticalAlignment, NullValue, ModerationStatusStatus, QueryPublicationsCountStatsRequestOrder, Order, WebhookIdentityType, GetPostTemplatesSort, Origin, Status, Field, PostFieldField, GetPostsSort, SortOrder, } from './blog-v3-post-posts.universal.js';
-export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, PostNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';
+export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';

build/internal/cjs/src/blog-v3-post-posts.http.d.ts

@@ -5,8 +5,8 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -37,18 +37,20 @@ export declare function queryPostCountStats(payload: object): RequestOptionsFactory<any>;
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -55,0 +57,0 @@ export declare function queryPosts(payload: object): RequestOptionsFactory<any>;

build/internal/cjs/src/blog-v3-post-posts.http.js

@@ -381,8 +381,8 @@ "use strict";
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -747,18 +747,20 @@ function queryPostCountStats(payload) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -765,0 +767,0 @@ function queryPosts(payload) {

build/internal/cjs/src/blog-v3-post-posts.public.d.ts

 import { EventDefinition, HttpClient } from '@wix/sdk-types';
-import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostNonNullableFields, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
+import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostResponse, GetPostResponseNonNullableFields, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
 export declare const __metadata: {
@@ -11,8 +11,9 @@ PACKAGE_NAME: string;
      *
-     * The time range is set 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 always ends on the last day of the month.
-     * > Note: If there are no published posts in a month within the time range, 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.
+     *
+     * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+     *
+     * 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.
+     *
+     * >**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.
+     * @param - Options specifying time frame, sort, and filter.
      * @returns Get Blog Post Count Stats response
@@ -26,2 +27,3 @@ */
      * Retrieves the total amount of published posts of the blog.
+     * @param - Language Options.
      */
@@ -35,5 +37,5 @@ (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
      * @param - Post ID.
-     * @returns Retrieved post info.
+     * @param - Options specifying which fields to return.
      */
-    (postId: string, options?: GetPostOptions | undefined): Promise<Post & PostNonNullableFields>;
+    (postId: string, options?: GetPostOptions | undefined): Promise<GetPostResponse & GetPostResponseNonNullableFields>;
 }
@@ -50,2 +52,3 @@ export declare function getPostBySlug(httpClient: HttpClient): GetPostBySlugSignature;
      * @param - Slug of the post to retrieve.
+     * @param - Options specifying which fields to return.
      */
@@ -63,2 +66,3 @@ (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
      * - `paging.offset` is `0`.
+     * @param - Sort, filter, and paging options.
      */
@@ -70,18 +74,21 @@ (options?: ListPostsOptions | undefined): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
     /**
-     * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of posts.
      *
-     * Query Posts runs with these defaults, which you can override:
-     * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
-     * - `paging.limit` is `50`.
-     * - `paging.offset` is `0`.
      *
-     * For field support for filters and sorting, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
      *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
-     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
-     * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
-     * For a detailed list of supported filters and sortable fields, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+     *
+     * 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.
+     *
+     * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+     * + `limit(50)`
+     * + `descending('firstPublishedDate')`
+     *
+     * Note that the default limit is `'50'`, but the max limit is `'100'`.
+     *
+     * To learn how to query posts, refer to the table below.
+     *
+     * 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`.
+     * @param - Options specifying which fields to return.
      */
@@ -105,2 +112,2 @@ (options?: QueryPostsOptions | undefined): PostsQueryBuilder;
 export declare const onPostUpdated: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
-export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostNonNullableFields, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';
+export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';

build/internal/cjs/src/blog-v3-post-posts.public.js

@@ -127,3 +127,3 @@ "use strict";
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostDeleted = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_deleted', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -197,3 +197,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostLiked = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_liked', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -204,3 +204,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostUnliked = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_unliked', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -211,3 +211,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 exports.onPostUpdated = (0, sdk_types_1.EventDefinition)('wix.blog.v3.post_updated', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
@@ -281,3 +281,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 var blog_v3_post_posts_universal_js_2 = require("./blog-v3-post-posts.universal.js");
@@ -284,0 +284,0 @@ Object.defineProperty(exports, "Alignment", { enumerable: true, get: function () { return blog_v3_post_posts_universal_js_2.Alignment; } });

build/internal/cjs/src/blog-v3-post-posts.universal.js

@@ -521,10 +521,11 @@ "use strict";
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  * @public
  * @documentationMaturity preview
+ * @param options - Options specifying time frame, sort, and filter.
  * @permissionId BLOG.READ-PUBLICATION
@@ -551,3 +552,3 @@ * @permissionScope Read Blog
         timeZone: options?.timeZone,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.queryPostCountStats(payload);
@@ -558,3 +559,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data, []);
     }
@@ -582,2 +583,3 @@ catch (err) {
  * @documentationMaturity preview
+ * @param options - Language Options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -597,5 +599,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[1];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-        language: options?.language,
-    });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ language: options?.language }, []);
     const reqOpts = ambassadorWixBlogV3Post.getTotalPosts(payload);
@@ -606,3 +606,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data, []);
     }
@@ -625,2 +625,3 @@ catch (err) {
  * @requiredField postId
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -635,3 +636,2 @@ * @permissionScope Read Blog
  * @applicableIdentity VISITOR
- * @returns Retrieved post info.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
@@ -642,6 +642,3 @@ */
     const { httpClient, sideEffects } = arguments[2];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-        postId: postId,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ postId: postId, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPost(payload);
@@ -673,3 +670,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]))?.post;
+        ]), ['post.rich_content']);
     }
@@ -700,2 +697,3 @@ catch (err) {
  * @requiredField slug
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -715,6 +713,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[2];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-        slug: slug,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ slug: slug, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostBySlug(payload);
@@ -746,3 +741,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['post.rich_content']);
     }
@@ -768,2 +763,3 @@ catch (err) {
  * @public
+ * @param options - Sort, filter, and paging options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -793,3 +789,3 @@ * @permissionScope Read Blog
         fieldsets: options?.fieldsets,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.listPosts(payload);
@@ -821,3 +817,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['posts.rich_content']);
     }
@@ -846,19 +842,22 @@ catch (err) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  * @public
+ * @param options - Options specifying which fields to return.
  * @permissionScope Read Blog
@@ -897,6 +896,3 @@ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
             const args = [query, options];
-            return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
-                ...args?.[1],
-                query: args?.[0],
-            });
+            return (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ ...args?.[1], query: args?.[0] }, []);
         },
@@ -925,3 +921,3 @@ responseTransformer: ({ data }) => {
                 },
-            ]));
+            ]), ['posts.rich_content']);
             return {
@@ -966,3 +962,3 @@ items: transformedData?.posts,
     const { httpClient, sideEffects } = arguments[1];
-    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ postId: postId });
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ postId: postId }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostMetrics(payload);
@@ -973,3 +969,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
+        return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data, []);
     }
@@ -976,0 +972,0 @@ catch (err) {

build/internal/es/src/blog-v3-post-posts.context.d.ts

@@ -37,2 +37,2 @@ import { queryPostCountStats as publicQueryPostCountStats, getTotalPosts as publicGetTotalPosts, getPost as publicGetPost, getPostBySlug as publicGetPostBySlug, listPosts as publicListPosts, queryPosts as publicQueryPosts, getPostMetrics as publicGetPostMetrics } from './blog-v3-post-posts.public.js';
 export { NodeType, WidthType, PluginContainerDataAlignment, Type, Target, TextAlignment, LineStyle, Width, Alignment, ViewMode, LayoutType, Orientation, Crop, ThumbnailsAlignment, GIFType, Source, Position, MapType, ViewRole, VoteRole, PollLayoutType, PollLayoutDirection, BackgroundType, DecorationType, FontType, AppType, InitialExpandedItems, Direction, VerticalAlignment, NullValue, ModerationStatusStatus, QueryPublicationsCountStatsRequestOrder, Order, WebhookIdentityType, GetPostTemplatesSort, Origin, Status, Field, PostFieldField, GetPostsSort, SortOrder, } from './blog-v3-post-posts.universal.js';
-export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, PostNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';
+export { Post, CoverMedia, CoverMediaMediaOneOf, FocalPoint, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, StylesBorder, ImageDataStyles, LinkPreviewData, LinkPreviewDataStyles, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, SpoilerData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, CaptionData, LayoutCellData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, PostTranslation, PostCategoriesUpdated, PostTagsUpdated, ScheduledPostPublished, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, CategoryTranslation, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, ViewPostRequest, ViewPostResponse, LikePostRequest, LikePostResponse, UnlikePostRequest, UnlikePostResponse, PinPostRequest, PinPostResponse, UnpinPostRequest, UnpinPostResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, ListDemoPostsRequest, ListDemoPostsResponse, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, OldBlogMigratedEvent, QueryPostCountStatsResponseNonNullableFields, GetTotalPostsResponseNonNullableFields, GetPostResponseNonNullableFields, GetPostBySlugResponseNonNullableFields, ListPostsResponseNonNullableFields, QueryPostsResponseNonNullableFields, GetPostMetricsResponseNonNullableFields, BaseEventMetadata, EventMetadata, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, QueryPostCountStatsOptions, GetTotalPostsOptions, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, } from './blog-v3-post-posts.universal.js';

build/internal/es/src/blog-v3-post-posts.http.d.ts

@@ -5,8 +5,8 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -37,18 +37,20 @@ export declare function queryPostCountStats(payload: object): RequestOptionsFactory<any>;
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -55,0 +57,0 @@ export declare function queryPosts(payload: object): RequestOptionsFactory<any>;

build/internal/es/src/blog-v3-post-posts.http.js

@@ -378,8 +378,8 @@ import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  */
@@ -739,18 +739,20 @@ export function queryPostCountStats(payload) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  */
@@ -757,0 +759,0 @@ export function queryPosts(payload) {

build/internal/es/src/blog-v3-post-posts.public.d.ts

 import { EventDefinition, HttpClient } from '@wix/sdk-types';
-import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostNonNullableFields, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
+import { GetPostBySlugOptions, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostResponse, GetPostResponseNonNullableFields, GetTotalPostsOptions, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, ListPostsOptions, ListPostsResponse, ListPostsResponseNonNullableFields, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions } from './blog-v3-post-posts.universal.js';
 export declare const __metadata: {
@@ -11,8 +11,9 @@ PACKAGE_NAME: string;
      *
-     * The time range is set 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 always ends on the last day of the month.
-     * > Note: If there are no published posts in a month within the time range, 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.
+     *
+     * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+     *
+     * 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.
+     *
+     * >**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.
+     * @param - Options specifying time frame, sort, and filter.
      * @returns Get Blog Post Count Stats response
@@ -26,2 +27,3 @@ */
      * Retrieves the total amount of published posts of the blog.
+     * @param - Language Options.
      */
@@ -35,5 +37,5 @@ (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
      * @param - Post ID.
-     * @returns Retrieved post info.
+     * @param - Options specifying which fields to return.
      */
-    (postId: string, options?: GetPostOptions | undefined): Promise<Post & PostNonNullableFields>;
+    (postId: string, options?: GetPostOptions | undefined): Promise<GetPostResponse & GetPostResponseNonNullableFields>;
 }
@@ -50,2 +52,3 @@ export declare function getPostBySlug(httpClient: HttpClient): GetPostBySlugSignature;
      * @param - Slug of the post to retrieve.
+     * @param - Options specifying which fields to return.
      */
@@ -63,2 +66,3 @@ (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
      * - `paging.offset` is `0`.
+     * @param - Sort, filter, and paging options.
      */
@@ -70,18 +74,21 @@ (options?: ListPostsOptions | undefined): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
     /**
-     * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of posts.
      *
-     * Query Posts runs with these defaults, which you can override:
-     * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
-     * - `paging.limit` is `50`.
-     * - `paging.offset` is `0`.
      *
-     * For field support for filters and sorting, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
      *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
-     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
-     * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
-     * For a detailed list of supported filters and sortable fields, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+     *
+     * 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.
+     *
+     * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+     * + `limit(50)`
+     * + `descending('firstPublishedDate')`
+     *
+     * Note that the default limit is `'50'`, but the max limit is `'100'`.
+     *
+     * To learn how to query posts, refer to the table below.
+     *
+     * 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`.
+     * @param - Options specifying which fields to return.
      */
@@ -105,2 +112,2 @@ (options?: QueryPostsOptions | undefined): PostsQueryBuilder;
 export declare const onPostUpdated: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
-export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostNonNullableFields, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';
+export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugOptions, GetPostBySlugRequest, GetPostBySlugResponse, GetPostBySlugResponseNonNullableFields, GetPostMetricsRequest, GetPostMetricsResponse, GetPostMetricsResponseNonNullableFields, GetPostOptions, GetPostRequest, GetPostResponse, GetPostResponseNonNullableFields, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsOptions, GetTotalPostsRequest, GetTotalPostsResponse, GetTotalPostsResponseNonNullableFields, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsOptions, ListPostsRequest, ListPostsResponse, ListPostsResponseNonNullableFields, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostCreatedEnvelope, PostDeletedEnvelope, PostFieldField, PostLiked, PostLikedEnvelope, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedEnvelope, PostUnlikedInitiatorOneOf, PostUpdatedEnvelope, PostsQueryBuilder, PostsQueryResult, QueryPostCountStatsOptions, QueryPostCountStatsRequest, QueryPostCountStatsResponse, QueryPostCountStatsResponseNonNullableFields, QueryPostsOptions, QueryPostsRequest, QueryPostsResponse, QueryPostsResponseNonNullableFields, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia, } from './blog-v3-post-posts.universal.js';

build/internal/es/src/blog-v3-post-posts.public.js

@@ -116,3 +116,3 @@ import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostDeleted = EventDefinition('wix.blog.v3.post_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -186,3 +186,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostLiked = EventDefinition('wix.blog.v3.post_liked', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -193,3 +193,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostUnliked = EventDefinition('wix.blog.v3.post_unliked', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -200,3 +200,3 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export const onPostUpdated = EventDefinition('wix.blog.v3.post_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
@@ -270,4 +270,4 @@ {
     },
-])))();
+]), ['entity.rich_content']))();
 export { Alignment, AppType, BackgroundType, Crop, DecorationType, Direction, Field, FontType, GIFType, GetPostTemplatesSort, GetPostsSort, InitialExpandedItems, LayoutType, LineStyle, MapType, ModerationStatusStatus, NodeType, NullValue, Order, Orientation, Origin, PluginContainerDataAlignment, PollLayoutDirection, PollLayoutType, Position, PostFieldField, QueryPublicationsCountStatsRequestOrder, SortOrder, Source, Status, Target, TextAlignment, ThumbnailsAlignment, Type, VerticalAlignment, ViewMode, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, } from './blog-v3-post-posts.universal.js';
 //# sourceMappingURL=blog-v3-post-posts.public.js.map

build/internal/es/src/blog-v3-post-posts.universal.js

@@ -495,10 +495,11 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
  *
- * The time range is set 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 always ends on the last day of the month.
- * > Note: If there are no published posts in a month within the time range, 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.
+ *
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+ *
+ * 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.
+ *
+ * >**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.
  * @public
  * @documentationMaturity preview
+ * @param options - Options specifying time frame, sort, and filter.
  * @permissionId BLOG.READ-PUBLICATION
@@ -525,3 +526,3 @@ * @permissionScope Read Blog
         timeZone: options?.timeZone,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.queryPostCountStats(payload);
@@ -532,3 +533,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
+        return renameKeysFromRESTResponseToSDKResponse(result.data, []);
     }
@@ -555,2 +556,3 @@ catch (err) {
  * @documentationMaturity preview
+ * @param options - Language Options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -570,5 +572,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        language: options?.language,
-    });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ language: options?.language }, []);
     const reqOpts = ambassadorWixBlogV3Post.getTotalPosts(payload);
@@ -579,3 +579,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
+        return renameKeysFromRESTResponseToSDKResponse(result.data, []);
     }
@@ -597,2 +597,3 @@ catch (err) {
  * @requiredField postId
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -607,3 +608,2 @@ * @permissionScope Read Blog
  * @applicableIdentity VISITOR
- * @returns Retrieved post info.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
@@ -614,6 +614,3 @@ */
     const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        postId: postId,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPost(payload);
@@ -645,3 +642,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]))?.post;
+        ]), ['post.rich_content']);
     }
@@ -671,2 +668,3 @@ catch (err) {
  * @requiredField slug
+ * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
@@ -686,6 +684,3 @@ * @permissionScope Read Blog
     const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        slug: slug,
-        fieldsets: options?.fieldsets,
-    });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ slug: slug, fieldsets: options?.fieldsets }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostBySlug(payload);
@@ -717,3 +712,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['post.rich_content']);
     }
@@ -738,2 +733,3 @@ catch (err) {
  * @public
+ * @param options - Sort, filter, and paging options.
  * @permissionId BLOG.READ-PUBLICATION
@@ -763,3 +759,3 @@ * @permissionScope Read Blog
         fieldsets: options?.fieldsets,
-    });
+    }, []);
     const reqOpts = ambassadorWixBlogV3Post.listPosts(payload);
@@ -791,3 +787,3 @@ sideEffects?.onSiteCall?.();
             },
-        ]));
+        ]), ['posts.rich_content']);
     }
@@ -815,19 +811,22 @@ catch (err) {
 /**
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+ * Creates a query to retrieve a list of posts.
  *
- * Query Posts runs with these defaults, which you can override:
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
- * - `paging.limit` is `50`.
- * - `paging.offset` is `0`.
  *
- * For field support for filters and sorting, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
  *
- * To learn about working with _Query_ endpoints, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * For a detailed list of supported filters and sortable fields, see
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * 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.
+ *
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+ * + `limit(50)`
+ * + `descending('firstPublishedDate')`
+ *
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * 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`.
  * @public
+ * @param options - Options specifying which fields to return.
  * @permissionScope Read Blog
@@ -866,6 +865,3 @@ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
             const args = [query, options];
-            return renameKeysFromSDKRequestToRESTRequest({
-                ...args?.[1],
-                query: args?.[0],
-            });
+            return renameKeysFromSDKRequestToRESTRequest({ ...args?.[1], query: args?.[0] }, []);
         },
@@ -894,3 +890,3 @@ responseTransformer: ({ data }) => {
                 },
-            ]));
+            ]), ['posts.rich_content']);
             return {
@@ -934,3 +930,3 @@ items: transformedData?.posts,
     const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId });
+    const payload = renameKeysFromSDKRequestToRESTRequest({ postId: postId }, []);
     const reqOpts = ambassadorWixBlogV3Post.getPostMetrics(payload);
@@ -941,3 +937,3 @@ sideEffects?.onSiteCall?.();
         sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
+        return renameKeysFromRESTResponseToSDKResponse(result.data, []);
     }
@@ -944,0 +940,0 @@ catch (err) {

package.json

 {
   "name": "@wix/auto_sdk_blog_posts",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "publishConfig": {
@@ -51,3 +51,3 @@ "registry": "https://registry.npmjs.org/",
   },
-  "falconPackageHash": "9e5c2ae4e6ba539e6808bd2f694c12430ff05c3cba7dcea2c2f8aab1"
+  "falconPackageHash": "3e0a6083fdf3598f25b352be38ced9ce56df9079571551cd2bb537c7"
 }

No alert changes

Improved metrics

Total package byte prevSize

1789500

0.45%

Lines of code

43326

0.18%

No dependency changes