@wix/auto_sdk_blog_posts 1.0.73 → 1.0.74

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,18 +1,19 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, Post, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope } from './index.typings.js';
3
- export { ActionEvent, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostMetricsRequest, GetPostRequest, GetPostResponse, GetPostTemplatesSort, GetPostTemplatesSortWithLiterals, GetPostsSort, GetPostsSortWithLiterals, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImagePosition, ImagePositionWithLiterals, ImageStyles, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, ModerationStatusStatusWithLiterals, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderWithLiterals, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlacementWithLiterals, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, PricingData, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsRequestOrderWithLiterals, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RestoreInfo, RibbonStyles, RichContent, Scaling, ScalingWithLiterals, ScheduledPostPublished, SeoSchema, Settings, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewPostResponse, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia } from './index.typings.js';
2
+ import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope } from './index.typings.js';
3
+ export { ActionEvent, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostMetricsRequest, GetPostRequest, GetPostTemplatesSort, GetPostTemplatesSortWithLiterals, GetPostsSort, GetPostsSortWithLiterals, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImagePosition, ImagePositionWithLiterals, ImageStyles, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, ModerationStatusStatusWithLiterals, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderWithLiterals, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlacementWithLiterals, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, PricingData, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsRequestOrderWithLiterals, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RestoreInfo, RibbonStyles, RichContent, Scaling, ScalingWithLiterals, ScheduledPostPublished, SeoSchema, Settings, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewPostResponse, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia } from './index.typings.js';
4
4
 
5
5
  declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
6
6
  interface QueryPostCountStatsSignature {
7
7
  /**
8
8
  * Retrieves the number of published posts per month within a specified time range.
9
9
  *
10
- * The time range is set using the `rangeStart` and `months` properties.
11
- * The time range always starts on the 1st day of the month set in `rangeStart` and
12
- * includes the number of `months` following `rangeStart`.
13
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
14
- * 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.
15
- * > 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.
10
+ *
11
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
12
+ *
13
+ * You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
14
+ *
15
+ * >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
16
+ * @param - Options specifying time frame, sort, and filter.
16
17
  * @returns Get Blog Post Count Stats response
17
18
  */
18
19
  (options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 4>>;
@@ -21,6 +22,7 @@ declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature
21
22
  interface GetTotalPostsSignature {
22
23
  /**
23
24
  * Retrieves the total amount of published posts of the blog.
25
+ * @param - Language Options.
24
26
  */
25
27
  (options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 2>>;
26
28
  }
@@ -29,9 +31,9 @@ interface GetPostSignature {
29
31
  /**
30
32
  * Retrieves a post by the specified ID.
31
33
  * @param - Post ID.
32
- * @returns Retrieved post info.
34
+ * @param - Options specifying which fields to return.
33
35
  */
34
- (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
36
+ (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
35
37
  }
36
38
  declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
37
39
  interface GetPostBySlugSignature {
@@ -43,6 +45,7 @@ interface GetPostBySlugSignature {
43
45
  * the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
44
46
  * unless specified otherwise.
45
47
  * @param - Slug of the post to retrieve.
48
+ * @param - Options specifying which fields to return.
46
49
  */
47
50
  (slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
48
51
  }
@@ -55,28 +58,32 @@ interface ListPostsSignature {
55
58
  * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
56
59
  * - `paging.limit` is `50`.
57
60
  * - `paging.offset` is `0`.
61
+ * @param - Sort, filter, and paging options.
58
62
  */
59
63
  (options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.coverMedia.enabled` | `posts.${number}.coverMedia.displayed` | `posts.${number}.coverMedia.custom` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges` | `metaData.count` | `metaData.offset` | `metaData.total`, 6>>;
60
64
  }
61
65
  declare function queryPosts$1(httpClient: HttpClient): QueryPostsSignature;
62
66
  interface QueryPostsSignature {
63
67
  /**
64
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
68
+ * Creates a query to retrieve a list of posts.
65
69
  *
66
- * Query Posts runs with these defaults, which you can override:
67
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
68
- * - `paging.limit` is `50`.
69
- * - `paging.offset` is `0`.
70
70
  *
71
- * For field support for filters and sorting, see
72
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
71
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
72
+ *
73
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
74
+ *
75
+ * 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.
76
+ *
77
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
78
+ * + `limit(50)`
79
+ * + `descending('firstPublishedDate')`
80
+ *
81
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
82
+ *
83
+ * To learn how to query posts, refer to the table below.
73
84
  *
74
- * To learn about working with _Query_ endpoints, see
75
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
76
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
77
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
78
- * For a detailed list of supported filters and sortable fields, see
79
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
85
+ * 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`.
86
+ * @param - Options specifying which fields to return.
80
87
  */
81
88
  (options?: QueryPostsOptions): PostsQueryBuilder;
82
89
  }
@@ -120,4 +127,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
120
127
  */
121
128
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
122
129
 
123
- export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
130
+ export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
@@ -1285,8 +1285,8 @@ async function getPost2(postId, options) {
1285
1285
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1286
1286
  }
1287
1287
  ]),
1288
- ["post.richContent"]
1289
- )?.post;
1288
+ ["post.richContent", "post.rich_content"]
1289
+ );
1290
1290
  } catch (err) {
1291
1291
  const transformedError = (0, import_transform_error.transformError)(
1292
1292
  err,
@@ -1338,7 +1338,7 @@ async function getPostBySlug2(slug, options) {
1338
1338
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1339
1339
  }
1340
1340
  ]),
1341
- ["post.richContent"]
1341
+ ["post.richContent", "post.rich_content"]
1342
1342
  );
1343
1343
  } catch (err) {
1344
1344
  const transformedError = (0, import_transform_error.transformError)(
@@ -1402,7 +1402,7 @@ async function listPosts2(options) {
1402
1402
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1403
1403
  }
1404
1404
  ]),
1405
- ["posts.richContent"]
1405
+ ["posts.richContent", "posts.rich_content"]
1406
1406
  );
1407
1407
  } catch (err) {
1408
1408
  const transformedError = (0, import_transform_error.transformError)(
@@ -1477,7 +1477,7 @@ function queryPosts2(options) {
1477
1477
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1478
1478
  }
1479
1479
  ]),
1480
- ["posts.richContent"]
1480
+ ["posts.richContent", "posts.rich_content"]
1481
1481
  );
1482
1482
  return {
1483
1483
  items: transformedData?.posts,
@@ -1581,7 +1581,8 @@ var onPostLiked = (0, import_sdk_types.EventDefinition)(
1581
1581
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1582
1582
  paths: [{ path: "metadata.eventTime" }]
1583
1583
  }
1584
- ])
1584
+ ]),
1585
+ ["entity.rich_content"]
1585
1586
  )
1586
1587
  )();
1587
1588
  var onPostUnliked = (0, import_sdk_types.EventDefinition)(
@@ -1593,7 +1594,8 @@ var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1593
1594
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1594
1595
  paths: [{ path: "metadata.eventTime" }]
1595
1596
  }
1596
- ])
1597
+ ]),
1598
+ ["entity.rich_content"]
1597
1599
  )
1598
1600
  )();
1599
1601
  var onPostCreated = (0, import_sdk_types.EventDefinition)(
@@ -1668,7 +1670,8 @@ var onPostCreated = (0, import_sdk_types.EventDefinition)(
1668
1670
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1669
1671
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1670
1672
  }
1671
- ])
1673
+ ]),
1674
+ ["entity.rich_content"]
1672
1675
  )
1673
1676
  )();
1674
1677
  var onPostDeleted = (0, import_sdk_types.EventDefinition)(
@@ -1743,7 +1746,8 @@ var onPostDeleted = (0, import_sdk_types.EventDefinition)(
1743
1746
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1744
1747
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1745
1748
  }
1746
- ])
1749
+ ]),
1750
+ ["entity.rich_content"]
1747
1751
  )
1748
1752
  )();
1749
1753
  var onPostUpdated = (0, import_sdk_types.EventDefinition)(
@@ -1818,7 +1822,8 @@ var onPostUpdated = (0, import_sdk_types.EventDefinition)(
1818
1822
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1819
1823
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1820
1824
  }
1821
- ])
1825
+ ]),
1826
+ ["entity.rich_content"]
1822
1827
  )
1823
1828
  )();
1824
1829