@wix/auto_sdk_blog_posts 1.0.55 → 1.0.57

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 +30 -41
  2. package/build/cjs/index.js +55 -39
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +122 -135
  5. package/build/cjs/index.typings.js +26 -5
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1378 -6
  8. package/build/cjs/meta.js +490 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +30 -41
  11. package/build/es/index.mjs +55 -39
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +122 -135
  14. package/build/es/index.typings.mjs +26 -5
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +1378 -6
  17. package/build/es/meta.mjs +442 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +30 -41
  20. package/build/internal/cjs/index.js +55 -39
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +122 -135
  23. package/build/internal/cjs/index.typings.js +26 -5
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +1378 -6
  26. package/build/internal/cjs/meta.js +490 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +30 -41
  29. package/build/internal/es/index.mjs +55 -39
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +122 -135
  32. package/build/internal/es/index.typings.mjs +26 -5
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +1378 -6
  35. package/build/internal/es/meta.mjs +442 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
@@ -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, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, 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, 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';
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
  }
@@ -97,10 +90,10 @@ interface GetPostMetricsSignature {
97
90
  */
98
91
  (postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
99
92
  }
100
- declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
101
- declare const onPostDeleted$1: EventDefinition<PostDeletedEnvelope, "wix.blog.v3.post_deleted">;
102
93
  declare const onPostLiked$1: EventDefinition<PostLikedEnvelope, "wix.blog.v3.post_liked">;
103
94
  declare const onPostUnliked$1: EventDefinition<PostUnlikedEnvelope, "wix.blog.v3.post_unliked">;
95
+ declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
96
+ declare const onPostDeleted$1: EventDefinition<PostDeletedEnvelope, "wix.blog.v3.post_deleted">;
104
97
  declare const onPostUpdated$1: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
105
98
 
106
99
  declare const queryPostCountStats: MaybeContext<BuildRESTFunction<typeof queryPostCountStats$1> & typeof queryPostCountStats$1>;
@@ -110,6 +103,10 @@ declare const getPostBySlug: MaybeContext<BuildRESTFunction<typeof getPostBySlug
110
103
  declare const listPosts: MaybeContext<BuildRESTFunction<typeof listPosts$1> & typeof listPosts$1>;
111
104
  declare const queryPosts: MaybeContext<BuildRESTFunction<typeof queryPosts$1> & typeof queryPosts$1>;
112
105
  declare const getPostMetrics: MaybeContext<BuildRESTFunction<typeof getPostMetrics$1> & typeof getPostMetrics$1>;
106
+ /** */
107
+ declare const onPostLiked: BuildEventDefinition<typeof onPostLiked$1> & typeof onPostLiked$1;
108
+ /** */
109
+ declare const onPostUnliked: BuildEventDefinition<typeof onPostUnliked$1> & typeof onPostUnliked$1;
113
110
  /**
114
111
  * Triggered when a post is created.
115
112
  */
@@ -118,17 +115,9 @@ declare const onPostCreated: BuildEventDefinition<typeof onPostCreated$1> & type
118
115
  * Triggered when a post is deleted.
119
116
  */
120
117
  declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & typeof onPostDeleted$1;
121
- /**
122
- * Triggered when a post is liked.
123
- */
124
- declare const onPostLiked: BuildEventDefinition<typeof onPostLiked$1> & typeof onPostLiked$1;
125
- /**
126
- * Triggered when a post is unliked.
127
- */
128
- declare const onPostUnliked: BuildEventDefinition<typeof onPostUnliked$1> & typeof onPostUnliked$1;
129
118
  /**
130
119
  * Triggered when a post is updated.
131
120
  */
132
121
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
133
122
 
134
- 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 };
@@ -488,6 +488,9 @@ function queryPostCountStats(payload) {
488
488
  method: "GET",
489
489
  methodFqn: "com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats",
490
490
  packageName: PACKAGE_NAME,
491
+ migrationOptions: {
492
+ optInTransformResponse: true
493
+ },
491
494
  url: resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl({
492
495
  protoPath: "/v2/stats/post/count",
493
496
  data: serializedData,
@@ -512,6 +515,9 @@ function getTotalPosts(payload) {
512
515
  method: "GET",
513
516
  methodFqn: "com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts",
514
517
  packageName: PACKAGE_NAME,
518
+ migrationOptions: {
519
+ optInTransformResponse: true
520
+ },
515
521
  url: resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl({
516
522
  protoPath: "/v2/stats/posts/total",
517
523
  data: payload,
@@ -530,6 +536,9 @@ function getPost(payload) {
530
536
  method: "GET",
531
537
  methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost",
532
538
  packageName: PACKAGE_NAME,
539
+ migrationOptions: {
540
+ optInTransformResponse: true
541
+ },
533
542
  url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
534
543
  protoPath: "/v3/posts/{postId}",
535
544
  data: payload,
@@ -624,6 +633,9 @@ function getPostBySlug(payload) {
624
633
  method: "GET",
625
634
  methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug",
626
635
  packageName: PACKAGE_NAME,
636
+ migrationOptions: {
637
+ optInTransformResponse: true
638
+ },
627
639
  url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
628
640
  protoPath: "/v3/posts/slugs/{slug}",
629
641
  data: payload,
@@ -718,6 +730,9 @@ function listPosts(payload) {
718
730
  method: "GET",
719
731
  methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts",
720
732
  packageName: PACKAGE_NAME,
733
+ migrationOptions: {
734
+ optInTransformResponse: true
735
+ },
721
736
  url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
722
737
  protoPath: "/v3/posts",
723
738
  data: payload,
@@ -816,6 +831,9 @@ function queryPosts(payload) {
816
831
  method: "POST",
817
832
  methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts",
818
833
  packageName: PACKAGE_NAME,
834
+ migrationOptions: {
835
+ optInTransformResponse: true
836
+ },
819
837
  url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
820
838
  protoPath: "/v3/posts/query",
821
839
  data: payload,
@@ -914,6 +932,9 @@ function getPostMetrics(payload) {
914
932
  method: "GET",
915
933
  methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics",
916
934
  packageName: PACKAGE_NAME,
935
+ migrationOptions: {
936
+ optInTransformResponse: true
937
+ },
917
938
  url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
918
939
  protoPath: "/v3/posts/{postId}/metrics",
919
940
  data: payload,
@@ -1407,8 +1428,8 @@ async function getPost2(postId, options) {
1407
1428
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1408
1429
  }
1409
1430
  ]),
1410
- ["post.richContent", "post.rich_content"]
1411
- );
1431
+ ["post.richContent"]
1432
+ )?.post;
1412
1433
  } catch (err) {
1413
1434
  const transformedError = (0, import_transform_error.transformError)(
1414
1435
  err,
@@ -1460,7 +1481,7 @@ async function getPostBySlug2(slug, options) {
1460
1481
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1461
1482
  }
1462
1483
  ]),
1463
- ["post.richContent", "post.rich_content"]
1484
+ ["post.richContent"]
1464
1485
  );
1465
1486
  } catch (err) {
1466
1487
  const transformedError = (0, import_transform_error.transformError)(
@@ -1524,7 +1545,7 @@ async function listPosts2(options) {
1524
1545
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1525
1546
  }
1526
1547
  ]),
1527
- ["posts.richContent", "posts.rich_content"]
1548
+ ["posts.richContent"]
1528
1549
  );
1529
1550
  } catch (err) {
1530
1551
  const transformedError = (0, import_transform_error.transformError)(
@@ -1599,7 +1620,7 @@ function queryPosts2(options) {
1599
1620
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1600
1621
  }
1601
1622
  ]),
1602
- ["posts.richContent", "posts.rich_content"]
1623
+ ["posts.richContent"]
1603
1624
  );
1604
1625
  return {
1605
1626
  items: transformedData?.posts,
@@ -1694,6 +1715,30 @@ function getPostMetrics3(httpClient) {
1694
1715
  { httpClient }
1695
1716
  );
1696
1717
  }
1718
+ var onPostLiked = (0, import_sdk_types.EventDefinition)(
1719
+ "wix.blog.v3.post_liked",
1720
+ true,
1721
+ (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
1722
+ (0, import_transform_paths3.transformPaths)(event, [
1723
+ {
1724
+ transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1725
+ paths: [{ path: "metadata.eventTime" }]
1726
+ }
1727
+ ])
1728
+ )
1729
+ )();
1730
+ var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1731
+ "wix.blog.v3.post_unliked",
1732
+ true,
1733
+ (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
1734
+ (0, import_transform_paths3.transformPaths)(event, [
1735
+ {
1736
+ transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1737
+ paths: [{ path: "metadata.eventTime" }]
1738
+ }
1739
+ ])
1740
+ )
1741
+ )();
1697
1742
  var onPostCreated = (0, import_sdk_types.EventDefinition)(
1698
1743
  "wix.blog.v3.post_created",
1699
1744
  true,
@@ -1766,8 +1811,7 @@ var onPostCreated = (0, import_sdk_types.EventDefinition)(
1766
1811
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1767
1812
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1768
1813
  }
1769
- ]),
1770
- ["entity.rich_content"]
1814
+ ])
1771
1815
  )
1772
1816
  )();
1773
1817
  var onPostDeleted = (0, import_sdk_types.EventDefinition)(
@@ -1842,34 +1886,7 @@ var onPostDeleted = (0, import_sdk_types.EventDefinition)(
1842
1886
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1843
1887
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1844
1888
  }
1845
- ]),
1846
- ["entity.rich_content"]
1847
- )
1848
- )();
1849
- var onPostLiked = (0, import_sdk_types.EventDefinition)(
1850
- "wix.blog.v3.post_liked",
1851
- true,
1852
- (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
1853
- (0, import_transform_paths3.transformPaths)(event, [
1854
- {
1855
- transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1856
- paths: [{ path: "metadata.eventTime" }]
1857
- }
1858
- ]),
1859
- ["entity.rich_content"]
1860
- )
1861
- )();
1862
- var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1863
- "wix.blog.v3.post_unliked",
1864
- true,
1865
- (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
1866
- (0, import_transform_paths3.transformPaths)(event, [
1867
- {
1868
- transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1869
- paths: [{ path: "metadata.eventTime" }]
1870
- }
1871
- ]),
1872
- ["entity.rich_content"]
1889
+ ])
1873
1890
  )
1874
1891
  )();
1875
1892
  var onPostUpdated = (0, import_sdk_types.EventDefinition)(
@@ -1944,8 +1961,7 @@ var onPostUpdated = (0, import_sdk_types.EventDefinition)(
1944
1961
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1945
1962
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1946
1963
  }
1947
- ]),
1948
- ["entity.rich_content"]
1964
+ ])
1949
1965
  )
1950
1966
  )();
1951
1967
 
@@ -1959,10 +1975,10 @@ var getPostBySlug4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(
1959
1975
  var listPosts4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(listPosts3);
1960
1976
  var queryPosts4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(queryPosts3);
1961
1977
  var getPostMetrics4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getPostMetrics3);
1962
- var onPostCreated2 = (0, import_event_definition_modules.createEventModule)(onPostCreated);
1963
- var onPostDeleted2 = (0, import_event_definition_modules.createEventModule)(onPostDeleted);
1964
1978
  var onPostLiked2 = (0, import_event_definition_modules.createEventModule)(onPostLiked);
1965
1979
  var onPostUnliked2 = (0, import_event_definition_modules.createEventModule)(onPostUnliked);
1980
+ var onPostCreated2 = (0, import_event_definition_modules.createEventModule)(onPostCreated);
1981
+ var onPostDeleted2 = (0, import_event_definition_modules.createEventModule)(onPostDeleted);
1966
1982
  var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPostUpdated);
1967
1983
  // Annotate the CommonJS export names for ESM import in node:
1968
1984
  0 && (module.exports = {