@wix/auto_sdk_blog_posts 1.0.66 → 1.0.68

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 +24 -31
  2. package/build/cjs/index.js +48 -195
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +124 -29
  5. package/build/cjs/index.typings.js +43 -185
  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 +38 -180
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +24 -31
  11. package/build/es/index.mjs +44 -195
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +124 -29
  14. package/build/es/index.typings.mjs +39 -185
  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 +34 -180
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +24 -31
  20. package/build/internal/cjs/index.js +48 -195
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +124 -29
  23. package/build/internal/cjs/index.typings.js +43 -185
  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 +38 -180
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +24 -31
  29. package/build/internal/es/index.mjs +44 -195
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +124 -29
  32. package/build/internal/es/index.typings.mjs +39 -185
  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 +34 -180
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -1,19 +1,18 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
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, 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, 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, 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, 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, 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';
4
4
 
5
5
  declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
6
6
  interface QueryPostCountStatsSignature {
7
7
  /**
8
8
  * Retrieves the number of published posts per month within a specified time range.
9
9
  *
10
- *
11
- * The `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.
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.
17
16
  * @returns Get Blog Post Count Stats response
18
17
  */
19
18
  (options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 4>>;
@@ -22,7 +21,6 @@ declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature
22
21
  interface GetTotalPostsSignature {
23
22
  /**
24
23
  * Retrieves the total amount of published posts of the blog.
25
- * @param - Language Options.
26
24
  */
27
25
  (options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 2>>;
28
26
  }
@@ -31,9 +29,9 @@ interface GetPostSignature {
31
29
  /**
32
30
  * Retrieves a post by the specified ID.
33
31
  * @param - Post ID.
34
- * @param - Options specifying which fields to return.
32
+ * @returns Retrieved post info.
35
33
  */
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>>;
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>>;
37
35
  }
38
36
  declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
39
37
  interface GetPostBySlugSignature {
@@ -45,7 +43,6 @@ interface GetPostBySlugSignature {
45
43
  * the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
46
44
  * unless specified otherwise.
47
45
  * @param - Slug of the post to retrieve.
48
- * @param - Options specifying which fields to return.
49
46
  */
50
47
  (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>>;
51
48
  }
@@ -58,32 +55,28 @@ interface ListPostsSignature {
58
55
  * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
59
56
  * - `paging.limit` is `50`.
60
57
  * - `paging.offset` is `0`.
61
- * @param - Sort, filter, and paging options.
62
58
  */
63
59
  (options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.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>>;
64
60
  }
65
61
  declare function queryPosts$1(httpClient: HttpClient): QueryPostsSignature;
66
62
  interface QueryPostsSignature {
67
63
  /**
68
- * Creates a query to retrieve a list of posts.
69
- *
70
- *
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.
64
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
74
65
  *
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'`.
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`.
82
70
  *
83
- * To learn how to query posts, refer to the table below.
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).
84
73
  *
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.
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).
87
80
  */
88
81
  (options?: QueryPostsOptions): PostsQueryBuilder;
89
82
  }
@@ -127,4 +120,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
127
120
  */
128
121
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
129
122
 
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 };
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 };
@@ -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,
@@ -109,186 +113,7 @@ var import_timestamp2 = require("@wix/sdk-runtime/transformations/timestamp");
109
113
  var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
110
114
  var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
111
115
  function resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl(opts) {
112
- const domainToMappings = {
113
- "api._api_base_domain_": [
114
- {
115
- srcPath: "/communities-blog-node-api",
116
- destPath: ""
117
- }
118
- ],
119
- "www._base_domain_": [
120
- {
121
- srcPath: "/_api/communities-blog-node-api",
122
- destPath: ""
123
- },
124
- {
125
- srcPath: "/_api/communities-blog-node-api/v3/posts",
126
- destPath: "/v3/posts"
127
- },
128
- {
129
- srcPath: "/_api/communities-blog-node-api/v2/stats",
130
- destPath: "/v2/stats"
131
- }
132
- ],
133
- "apps._base_domain_": [
134
- {
135
- srcPath: "/_api/communities-blog-node-api",
136
- destPath: ""
137
- },
138
- {
139
- srcPath: "/_api/communities-blog-node-api/v3/posts",
140
- destPath: "/v3/posts"
141
- },
142
- {
143
- srcPath: "/_api/communities-blog-node-api/v2/stats",
144
- destPath: "/v2/stats"
145
- }
146
- ],
147
- _: [
148
- {
149
- srcPath: "/_api/communities-blog-node-api",
150
- destPath: ""
151
- },
152
- {
153
- srcPath: "/_api/communities-blog-node-api/_api/blogs/this",
154
- destPath: "/_api/blogs/this"
155
- },
156
- {
157
- srcPath: "/_api/communities-blog-node-api/_api/categories",
158
- destPath: "/_api/categories"
159
- },
160
- {
161
- srcPath: "/_api/communities-blog-node-api/_api/site-properties",
162
- destPath: "/_api/site-properties"
163
- },
164
- {
165
- srcPath: "/_api/communities-blog-node-api/_api/posts/content",
166
- destPath: "/_api/posts/content"
167
- },
168
- {
169
- srcPath: "/_api/communities-blog-node-api/v3/posts",
170
- destPath: "/v3/posts"
171
- },
172
- {
173
- srcPath: "/_api/communities-blog-node-api/v2/stats",
174
- destPath: "/v2/stats"
175
- }
176
- ],
177
- "editor._base_domain_": [
178
- {
179
- srcPath: "/_api/communities-blog-node-api",
180
- destPath: ""
181
- }
182
- ],
183
- "blocks._base_domain_": [
184
- {
185
- srcPath: "/_api/communities-blog-node-api",
186
- destPath: ""
187
- }
188
- ],
189
- "create.editorx": [
190
- {
191
- srcPath: "/_api/communities-blog-node-api",
192
- destPath: ""
193
- }
194
- ],
195
- "*.dev.wix-code.com": [
196
- {
197
- srcPath: "/_api/communities-blog-node-api",
198
- destPath: ""
199
- }
200
- ],
201
- "*.pub.wix-code.com": [
202
- {
203
- srcPath: "/_api/communities-blog-node-api",
204
- destPath: ""
205
- }
206
- ],
207
- "bo._base_domain_": [
208
- {
209
- srcPath: "/_api/communities-blog-node-api",
210
- destPath: ""
211
- },
212
- {
213
- srcPath: "/_api/communities-blog-node-api",
214
- destPath: ""
215
- }
216
- ],
217
- "wixbo.ai": [
218
- {
219
- srcPath: "/_api/communities-blog-node-api",
220
- destPath: ""
221
- },
222
- {
223
- srcPath: "/_api/communities-blog-node-api",
224
- destPath: ""
225
- }
226
- ],
227
- "wix-bo.com": [
228
- {
229
- srcPath: "/_api/communities-blog-node-api",
230
- destPath: ""
231
- },
232
- {
233
- srcPath: "/_api/communities-blog-node-api",
234
- destPath: ""
235
- }
236
- ],
237
- "manage._base_domain_": [
238
- {
239
- srcPath: "/_api/communities-blog-node-api",
240
- destPath: ""
241
- }
242
- ],
243
- "social-blog._base_domain_": [
244
- {
245
- srcPath: "/_api/communities-blog-node-api",
246
- destPath: ""
247
- }
248
- ],
249
- "editor.wixapps.net": [
250
- {
251
- srcPath: "/_api/communities-blog-node-api",
252
- destPath: ""
253
- }
254
- ],
255
- "dev._base_domain_": [
256
- {
257
- srcPath: "/_api/communities-blog-node-api",
258
- destPath: ""
259
- }
260
- ],
261
- "www.wixapis.com": [
262
- {
263
- srcPath: "/blog/v2",
264
- destPath: "/v2"
265
- },
266
- {
267
- srcPath: "/blog/v3",
268
- destPath: "/v3"
269
- },
270
- {
271
- srcPath: "/v2/stats",
272
- destPath: "/v2/stats"
273
- },
274
- {
275
- srcPath: "/v3/posts",
276
- destPath: "/v3/posts"
277
- },
278
- {
279
- srcPath: "/blog/v3/posts",
280
- destPath: "/v3/posts"
281
- },
282
- {
283
- srcPath: "/blog/v2/stats",
284
- destPath: "/v2/stats"
285
- },
286
- {
287
- srcPath: "/_api/v3/posts",
288
- destPath: "/v3/posts"
289
- }
290
- ]
291
- };
116
+ const domainToMappings = {};
292
117
  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
293
118
  }
294
119
  function resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl(opts) {
@@ -1217,6 +1042,35 @@ var NullValue = /* @__PURE__ */ ((NullValue2) => {
1217
1042
  NullValue2["NULL_VALUE"] = "NULL_VALUE";
1218
1043
  return NullValue2;
1219
1044
  })(NullValue || {});
1045
+ var Scaling = /* @__PURE__ */ ((Scaling2) => {
1046
+ Scaling2["AUTO"] = "AUTO";
1047
+ Scaling2["CONTAIN"] = "CONTAIN";
1048
+ Scaling2["COVER"] = "COVER";
1049
+ return Scaling2;
1050
+ })(Scaling || {});
1051
+ var ImagePosition = /* @__PURE__ */ ((ImagePosition2) => {
1052
+ ImagePosition2["CENTER"] = "CENTER";
1053
+ ImagePosition2["CENTER_LEFT"] = "CENTER_LEFT";
1054
+ ImagePosition2["CENTER_RIGHT"] = "CENTER_RIGHT";
1055
+ ImagePosition2["TOP"] = "TOP";
1056
+ ImagePosition2["TOP_LEFT"] = "TOP_LEFT";
1057
+ ImagePosition2["TOP_RIGHT"] = "TOP_RIGHT";
1058
+ ImagePosition2["BOTTOM"] = "BOTTOM";
1059
+ ImagePosition2["BOTTOM_LEFT"] = "BOTTOM_LEFT";
1060
+ ImagePosition2["BOTTOM_RIGHT"] = "BOTTOM_RIGHT";
1061
+ return ImagePosition2;
1062
+ })(ImagePosition || {});
1063
+ var VerticalAlignmentAlignment = /* @__PURE__ */ ((VerticalAlignmentAlignment2) => {
1064
+ VerticalAlignmentAlignment2["TOP"] = "TOP";
1065
+ VerticalAlignmentAlignment2["MIDDLE"] = "MIDDLE";
1066
+ VerticalAlignmentAlignment2["BOTTOM"] = "BOTTOM";
1067
+ return VerticalAlignmentAlignment2;
1068
+ })(VerticalAlignmentAlignment || {});
1069
+ var ResponsivenessBehaviour = /* @__PURE__ */ ((ResponsivenessBehaviour2) => {
1070
+ ResponsivenessBehaviour2["STACK"] = "STACK";
1071
+ ResponsivenessBehaviour2["WRAP"] = "WRAP";
1072
+ return ResponsivenessBehaviour2;
1073
+ })(ResponsivenessBehaviour || {});
1220
1074
  var ModerationStatusStatus = /* @__PURE__ */ ((ModerationStatusStatus2) => {
1221
1075
  ModerationStatusStatus2["UNKNOWN"] = "UNKNOWN";
1222
1076
  ModerationStatusStatus2["APPROVED"] = "APPROVED";
@@ -1428,8 +1282,8 @@ async function getPost2(postId, options) {
1428
1282
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1429
1283
  }
1430
1284
  ]),
1431
- ["post.richContent", "post.rich_content"]
1432
- );
1285
+ ["post.richContent"]
1286
+ )?.post;
1433
1287
  } catch (err) {
1434
1288
  const transformedError = (0, import_transform_error.transformError)(
1435
1289
  err,
@@ -1481,7 +1335,7 @@ async function getPostBySlug2(slug, options) {
1481
1335
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1482
1336
  }
1483
1337
  ]),
1484
- ["post.richContent", "post.rich_content"]
1338
+ ["post.richContent"]
1485
1339
  );
1486
1340
  } catch (err) {
1487
1341
  const transformedError = (0, import_transform_error.transformError)(
@@ -1545,7 +1399,7 @@ async function listPosts2(options) {
1545
1399
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1546
1400
  }
1547
1401
  ]),
1548
- ["posts.richContent", "posts.rich_content"]
1402
+ ["posts.richContent"]
1549
1403
  );
1550
1404
  } catch (err) {
1551
1405
  const transformedError = (0, import_transform_error.transformError)(
@@ -1620,7 +1474,7 @@ function queryPosts2(options) {
1620
1474
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1621
1475
  }
1622
1476
  ]),
1623
- ["posts.richContent", "posts.rich_content"]
1477
+ ["posts.richContent"]
1624
1478
  );
1625
1479
  return {
1626
1480
  items: transformedData?.posts,
@@ -1724,8 +1578,7 @@ var onPostLiked = (0, import_sdk_types.EventDefinition)(
1724
1578
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1725
1579
  paths: [{ path: "metadata.eventTime" }]
1726
1580
  }
1727
- ]),
1728
- ["entity.rich_content"]
1581
+ ])
1729
1582
  )
1730
1583
  )();
1731
1584
  var onPostUnliked = (0, import_sdk_types.EventDefinition)(
@@ -1737,8 +1590,7 @@ var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1737
1590
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1738
1591
  paths: [{ path: "metadata.eventTime" }]
1739
1592
  }
1740
- ]),
1741
- ["entity.rich_content"]
1593
+ ])
1742
1594
  )
1743
1595
  )();
1744
1596
  var onPostCreated = (0, import_sdk_types.EventDefinition)(
@@ -1813,8 +1665,7 @@ var onPostCreated = (0, import_sdk_types.EventDefinition)(
1813
1665
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1814
1666
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1815
1667
  }
1816
- ]),
1817
- ["entity.rich_content"]
1668
+ ])
1818
1669
  )
1819
1670
  )();
1820
1671
  var onPostDeleted = (0, import_sdk_types.EventDefinition)(
@@ -1889,8 +1740,7 @@ var onPostDeleted = (0, import_sdk_types.EventDefinition)(
1889
1740
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1890
1741
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1891
1742
  }
1892
- ]),
1893
- ["entity.rich_content"]
1743
+ ])
1894
1744
  )
1895
1745
  )();
1896
1746
  var onPostUpdated = (0, import_sdk_types.EventDefinition)(
@@ -1965,8 +1815,7 @@ var onPostUpdated = (0, import_sdk_types.EventDefinition)(
1965
1815
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1966
1816
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1967
1817
  }
1968
- ]),
1969
- ["entity.rich_content"]
1818
+ ])
1970
1819
  )
1971
1820
  )();
1972
1821
 
@@ -2001,6 +1850,7 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
2001
1850
  GIFType,
2002
1851
  GetPostTemplatesSort,
2003
1852
  GetPostsSort,
1853
+ ImagePosition,
2004
1854
  InitialExpandedItems,
2005
1855
  Layout,
2006
1856
  LayoutType,
@@ -2020,6 +1870,8 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
2020
1870
  PostFieldField,
2021
1871
  QueryPublicationsCountStatsRequestOrder,
2022
1872
  Resizing,
1873
+ ResponsivenessBehaviour,
1874
+ Scaling,
2023
1875
  SortOrder,
2024
1876
  Source,
2025
1877
  Status,
@@ -2029,6 +1881,7 @@ var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPo
2029
1881
  ThumbnailsAlignment,
2030
1882
  Type,
2031
1883
  VerticalAlignment,
1884
+ VerticalAlignmentAlignment,
2032
1885
  ViewMode,
2033
1886
  ViewRole,
2034
1887
  VoteRole,