@wix/auto_sdk_blog_posts 1.0.63 → 1.0.65

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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +31 -24
  2. package/build/cjs/index.js +52 -10
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +131 -22
  5. package/build/cjs/index.typings.js +42 -5
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +103 -1
  8. package/build/cjs/meta.js +37 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +31 -24
  11. package/build/es/index.mjs +48 -10
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +131 -22
  14. package/build/es/index.typings.mjs +38 -5
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +103 -1
  17. package/build/es/meta.mjs +33 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +31 -24
  20. package/build/internal/cjs/index.js +52 -10
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +131 -22
  23. package/build/internal/cjs/index.typings.js +42 -5
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +103 -1
  26. package/build/internal/cjs/meta.js +37 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +31 -24
  29. package/build/internal/es/index.mjs +48 -10
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +131 -22
  32. package/build/internal/es/index.typings.mjs +38 -5
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +103 -1
  35. package/build/internal/es/meta.mjs +33 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -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, 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, ImageStyles, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, 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, RestoreInfo, RibbonStyles, RichContent, 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, 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 };
@@ -34,6 +34,7 @@ __export(index_exports, {
34
34
  GIFType: () => GIFType,
35
35
  GetPostTemplatesSort: () => GetPostTemplatesSort,
36
36
  GetPostsSort: () => GetPostsSort,
37
+ ImagePosition: () => ImagePosition,
37
38
  InitialExpandedItems: () => InitialExpandedItems,
38
39
  Layout: () => Layout,
39
40
  LayoutType: () => LayoutType,
@@ -53,6 +54,8 @@ __export(index_exports, {
53
54
  PostFieldField: () => PostFieldField,
54
55
  QueryPublicationsCountStatsRequestOrder: () => QueryPublicationsCountStatsRequestOrder,
55
56
  Resizing: () => Resizing,
57
+ ResponsivenessBehaviour: () => ResponsivenessBehaviour,
58
+ Scaling: () => Scaling,
56
59
  SortOrder: () => SortOrder,
57
60
  Source: () => Source,
58
61
  Status: () => Status,
@@ -62,6 +65,7 @@ __export(index_exports, {
62
65
  ThumbnailsAlignment: () => ThumbnailsAlignment,
63
66
  Type: () => Type,
64
67
  VerticalAlignment: () => VerticalAlignment,
68
+ VerticalAlignmentAlignment: () => VerticalAlignmentAlignment,
65
69
  ViewMode: () => ViewMode,
66
70
  ViewRole: () => ViewRole,
67
71
  VoteRole: () => VoteRole,
@@ -1217,6 +1221,35 @@ var NullValue = /* @__PURE__ */ ((NullValue2) => {
1217
1221
  NullValue2["NULL_VALUE"] = "NULL_VALUE";
1218
1222
  return NullValue2;
1219
1223
  })(NullValue || {});
1224
+ var Scaling = /* @__PURE__ */ ((Scaling2) => {
1225
+ Scaling2["AUTO"] = "AUTO";
1226
+ Scaling2["CONTAIN"] = "CONTAIN";
1227
+ Scaling2["COVER"] = "COVER";
1228
+ return Scaling2;
1229
+ })(Scaling || {});
1230
+ var ImagePosition = /* @__PURE__ */ ((ImagePosition2) => {
1231
+ ImagePosition2["CENTER"] = "CENTER";
1232
+ ImagePosition2["CENTER_LEFT"] = "CENTER_LEFT";
1233
+ ImagePosition2["CENTER_RIGHT"] = "CENTER_RIGHT";
1234
+ ImagePosition2["TOP"] = "TOP";
1235
+ ImagePosition2["TOP_LEFT"] = "TOP_LEFT";
1236
+ ImagePosition2["TOP_RIGHT"] = "TOP_RIGHT";
1237
+ ImagePosition2["BOTTOM"] = "BOTTOM";
1238
+ ImagePosition2["BOTTOM_LEFT"] = "BOTTOM_LEFT";
1239
+ ImagePosition2["BOTTOM_RIGHT"] = "BOTTOM_RIGHT";
1240
+ return ImagePosition2;
1241
+ })(ImagePosition || {});
1242
+ var VerticalAlignmentAlignment = /* @__PURE__ */ ((VerticalAlignmentAlignment2) => {
1243
+ VerticalAlignmentAlignment2["TOP"] = "TOP";
1244
+ VerticalAlignmentAlignment2["MIDDLE"] = "MIDDLE";
1245
+ VerticalAlignmentAlignment2["BOTTOM"] = "BOTTOM";
1246
+ return VerticalAlignmentAlignment2;
1247
+ })(VerticalAlignmentAlignment || {});
1248
+ var ResponsivenessBehaviour = /* @__PURE__ */ ((ResponsivenessBehaviour2) => {
1249
+ ResponsivenessBehaviour2["STACK"] = "STACK";
1250
+ ResponsivenessBehaviour2["WRAP"] = "WRAP";
1251
+ return ResponsivenessBehaviour2;
1252
+ })(ResponsivenessBehaviour || {});
1220
1253
  var ModerationStatusStatus = /* @__PURE__ */ ((ModerationStatusStatus2) => {
1221
1254
  ModerationStatusStatus2["UNKNOWN"] = "UNKNOWN";
1222
1255
  ModerationStatusStatus2["APPROVED"] = "APPROVED";
@@ -1428,8 +1461,8 @@ async function getPost2(postId, options) {
1428
1461
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1429
1462
  }
1430
1463
  ]),
1431
- ["post.richContent"]
1432
- )?.post;
1464
+ ["post.richContent", "post.rich_content"]
1465
+ );
1433
1466
  } catch (err) {
1434
1467
  const transformedError = (0, import_transform_error.transformError)(
1435
1468
  err,
@@ -1481,7 +1514,7 @@ async function getPostBySlug2(slug, options) {
1481
1514
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1482
1515
  }
1483
1516
  ]),
1484
- ["post.richContent"]
1517
+ ["post.richContent", "post.rich_content"]
1485
1518
  );
1486
1519
  } catch (err) {
1487
1520
  const transformedError = (0, import_transform_error.transformError)(
@@ -1545,7 +1578,7 @@ async function listPosts2(options) {
1545
1578
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1546
1579
  }
1547
1580
  ]),
1548
- ["posts.richContent"]
1581
+ ["posts.richContent", "posts.rich_content"]
1549
1582
  );
1550
1583
  } catch (err) {
1551
1584
  const transformedError = (0, import_transform_error.transformError)(
@@ -1620,7 +1653,7 @@ function queryPosts2(options) {
1620
1653
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1621
1654
  }
1622
1655
  ]),
1623
- ["posts.richContent"]
1656
+ ["posts.richContent", "posts.rich_content"]
1624
1657
  );
1625
1658
  return {
1626
1659
  items: transformedData?.posts,
@@ -1724,7 +1757,8 @@ var onPostLiked = (0, import_sdk_types.EventDefinition)(
1724
1757
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1725
1758
  paths: [{ path: "metadata.eventTime" }]
1726
1759
  }
1727
- ])
1760
+ ]),
1761
+ ["entity.rich_content"]
1728
1762
  )
1729
1763
  )();
1730
1764
  var onPostUnliked = (0, import_sdk_types.EventDefinition)(
@@ -1736,7 +1770,8 @@ var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1736
1770
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1737
1771
  paths: [{ path: "metadata.eventTime" }]
1738
1772
  }
1739
- ])
1773
+ ]),
1774
+ ["entity.rich_content"]
1740
1775
  )
1741
1776
  )();
1742
1777
  var onPostCreated = (0, import_sdk_types.EventDefinition)(
@@ -1811,7 +1846,8 @@ var onPostCreated = (0, import_sdk_types.EventDefinition)(
1811
1846
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1812
1847
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1813
1848
  }
1814
- ])
1849
+ ]),
1850
+ ["entity.rich_content"]
1815
1851
  )
1816
1852
  )();
1817
1853
  var onPostDeleted = (0, import_sdk_types.EventDefinition)(
@@ -1886,7 +1922,8 @@ var onPostDeleted = (0, import_sdk_types.EventDefinition)(
1886
1922
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1887
1923
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1888
1924
  }
1889
- ])
1925
+ ]),
1926
+ ["entity.rich_content"]
1890
1927
  )
1891
1928
  )();
1892
1929
  var onPostUpdated = (0, import_sdk_types.EventDefinition)(
@@ -1961,7 +1998,8 @@ var onPostUpdated = (0, import_sdk_types.EventDefinition)(
1961
1998
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1962
1999
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1963
2000
  }
1964
- ])
2001
+ ]),
2002
+ ["entity.rich_content"]
1965
2003
  )
1966
2004
  )();
1967
2005
 
@@ -1996,6 +2034,7 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
1996
2034
  GIFType,
1997
2035
  GetPostTemplatesSort,
1998
2036
  GetPostsSort,
2037
+ ImagePosition,
1999
2038
  InitialExpandedItems,
2000
2039
  Layout,
2001
2040
  LayoutType,
@@ -2015,6 +2054,8 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
2015
2054
  PostFieldField,
2016
2055
  QueryPublicationsCountStatsRequestOrder,
2017
2056
  Resizing,
2057
+ ResponsivenessBehaviour,
2058
+ Scaling,
2018
2059
  SortOrder,
2019
2060
  Source,
2020
2061
  Status,
@@ -2024,6 +2065,7 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
2024
2065
  ThumbnailsAlignment,
2025
2066
  Type,
2026
2067
  VerticalAlignment,
2068
+ VerticalAlignmentAlignment,
2027
2069
  ViewMode,
2028
2070
  ViewRole,
2029
2071
  VoteRole,