@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.mjs';
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.mjs';
2
+ import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope } from './index.typings.mjs';
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.mjs';
4
4
 
5
5
  declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
6
6
  interface QueryPostCountStatsSignature {
7
7
  /**
8
8
  * Retrieves the number of published posts per month within a specified time range.
9
9
  *
10
- * 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 };
@@ -1135,6 +1135,35 @@ var NullValue = /* @__PURE__ */ ((NullValue2) => {
1135
1135
  NullValue2["NULL_VALUE"] = "NULL_VALUE";
1136
1136
  return NullValue2;
1137
1137
  })(NullValue || {});
1138
+ var Scaling = /* @__PURE__ */ ((Scaling2) => {
1139
+ Scaling2["AUTO"] = "AUTO";
1140
+ Scaling2["CONTAIN"] = "CONTAIN";
1141
+ Scaling2["COVER"] = "COVER";
1142
+ return Scaling2;
1143
+ })(Scaling || {});
1144
+ var ImagePosition = /* @__PURE__ */ ((ImagePosition2) => {
1145
+ ImagePosition2["CENTER"] = "CENTER";
1146
+ ImagePosition2["CENTER_LEFT"] = "CENTER_LEFT";
1147
+ ImagePosition2["CENTER_RIGHT"] = "CENTER_RIGHT";
1148
+ ImagePosition2["TOP"] = "TOP";
1149
+ ImagePosition2["TOP_LEFT"] = "TOP_LEFT";
1150
+ ImagePosition2["TOP_RIGHT"] = "TOP_RIGHT";
1151
+ ImagePosition2["BOTTOM"] = "BOTTOM";
1152
+ ImagePosition2["BOTTOM_LEFT"] = "BOTTOM_LEFT";
1153
+ ImagePosition2["BOTTOM_RIGHT"] = "BOTTOM_RIGHT";
1154
+ return ImagePosition2;
1155
+ })(ImagePosition || {});
1156
+ var VerticalAlignmentAlignment = /* @__PURE__ */ ((VerticalAlignmentAlignment2) => {
1157
+ VerticalAlignmentAlignment2["TOP"] = "TOP";
1158
+ VerticalAlignmentAlignment2["MIDDLE"] = "MIDDLE";
1159
+ VerticalAlignmentAlignment2["BOTTOM"] = "BOTTOM";
1160
+ return VerticalAlignmentAlignment2;
1161
+ })(VerticalAlignmentAlignment || {});
1162
+ var ResponsivenessBehaviour = /* @__PURE__ */ ((ResponsivenessBehaviour2) => {
1163
+ ResponsivenessBehaviour2["STACK"] = "STACK";
1164
+ ResponsivenessBehaviour2["WRAP"] = "WRAP";
1165
+ return ResponsivenessBehaviour2;
1166
+ })(ResponsivenessBehaviour || {});
1138
1167
  var ModerationStatusStatus = /* @__PURE__ */ ((ModerationStatusStatus2) => {
1139
1168
  ModerationStatusStatus2["UNKNOWN"] = "UNKNOWN";
1140
1169
  ModerationStatusStatus2["APPROVED"] = "APPROVED";
@@ -1346,8 +1375,8 @@ async function getPost2(postId, options) {
1346
1375
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1347
1376
  }
1348
1377
  ]),
1349
- ["post.richContent"]
1350
- )?.post;
1378
+ ["post.richContent", "post.rich_content"]
1379
+ );
1351
1380
  } catch (err) {
1352
1381
  const transformedError = sdkTransformError(
1353
1382
  err,
@@ -1399,7 +1428,7 @@ async function getPostBySlug2(slug, options) {
1399
1428
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1400
1429
  }
1401
1430
  ]),
1402
- ["post.richContent"]
1431
+ ["post.richContent", "post.rich_content"]
1403
1432
  );
1404
1433
  } catch (err) {
1405
1434
  const transformedError = sdkTransformError(
@@ -1463,7 +1492,7 @@ async function listPosts2(options) {
1463
1492
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1464
1493
  }
1465
1494
  ]),
1466
- ["posts.richContent"]
1495
+ ["posts.richContent", "posts.rich_content"]
1467
1496
  );
1468
1497
  } catch (err) {
1469
1498
  const transformedError = sdkTransformError(
@@ -1538,7 +1567,7 @@ function queryPosts2(options) {
1538
1567
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1539
1568
  }
1540
1569
  ]),
1541
- ["posts.richContent"]
1570
+ ["posts.richContent", "posts.rich_content"]
1542
1571
  );
1543
1572
  return {
1544
1573
  items: transformedData?.posts,
@@ -1642,7 +1671,8 @@ var onPostLiked = EventDefinition(
1642
1671
  transformFn: transformRESTTimestampToSDKTimestamp2,
1643
1672
  paths: [{ path: "metadata.eventTime" }]
1644
1673
  }
1645
- ])
1674
+ ]),
1675
+ ["entity.rich_content"]
1646
1676
  )
1647
1677
  )();
1648
1678
  var onPostUnliked = EventDefinition(
@@ -1654,7 +1684,8 @@ var onPostUnliked = EventDefinition(
1654
1684
  transformFn: transformRESTTimestampToSDKTimestamp2,
1655
1685
  paths: [{ path: "metadata.eventTime" }]
1656
1686
  }
1657
- ])
1687
+ ]),
1688
+ ["entity.rich_content"]
1658
1689
  )
1659
1690
  )();
1660
1691
  var onPostCreated = EventDefinition(
@@ -1729,7 +1760,8 @@ var onPostCreated = EventDefinition(
1729
1760
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1730
1761
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1731
1762
  }
1732
- ])
1763
+ ]),
1764
+ ["entity.rich_content"]
1733
1765
  )
1734
1766
  )();
1735
1767
  var onPostDeleted = EventDefinition(
@@ -1804,7 +1836,8 @@ var onPostDeleted = EventDefinition(
1804
1836
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1805
1837
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1806
1838
  }
1807
- ])
1839
+ ]),
1840
+ ["entity.rich_content"]
1808
1841
  )
1809
1842
  )();
1810
1843
  var onPostUpdated = EventDefinition(
@@ -1879,7 +1912,8 @@ var onPostUpdated = EventDefinition(
1879
1912
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1880
1913
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1881
1914
  }
1882
- ])
1915
+ ]),
1916
+ ["entity.rich_content"]
1883
1917
  )
1884
1918
  )();
1885
1919
 
@@ -1913,6 +1947,7 @@ export {
1913
1947
  GIFType,
1914
1948
  GetPostTemplatesSort,
1915
1949
  GetPostsSort,
1950
+ ImagePosition,
1916
1951
  InitialExpandedItems,
1917
1952
  Layout,
1918
1953
  LayoutType,
@@ -1932,6 +1967,8 @@ export {
1932
1967
  PostFieldField,
1933
1968
  QueryPublicationsCountStatsRequestOrder,
1934
1969
  Resizing,
1970
+ ResponsivenessBehaviour,
1971
+ Scaling,
1935
1972
  SortOrder,
1936
1973
  Source,
1937
1974
  Status,
@@ -1941,6 +1978,7 @@ export {
1941
1978
  ThumbnailsAlignment,
1942
1979
  Type,
1943
1980
  VerticalAlignment,
1981
+ VerticalAlignmentAlignment,
1944
1982
  ViewMode,
1945
1983
  ViewRole,
1946
1984
  VoteRole,