@wix/auto_sdk_blog_posts 1.0.54 → 1.0.56

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,18 +1,19 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, Post, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, 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, GetPostResponse, GetPostTemplatesSort, GetPostTemplatesSortWithLiterals, GetPostsSort, GetPostsSortWithLiterals, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImageStyles, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, ModerationStatusStatusWithLiterals, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderWithLiterals, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlacementWithLiterals, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, PricingData, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsRequestOrderWithLiterals, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, ResizingWithLiterals, RestoreInfo, RibbonStyles, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewPostResponse, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia } from './index.typings.js';
2
+ import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope } from './index.typings.js';
3
+ export { ActionEvent, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, 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';
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.
73
72
  *
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).
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.
84
+ *
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
  }
@@ -90,10 +97,10 @@ interface GetPostMetricsSignature {
90
97
  */
91
98
  (postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
92
99
  }
93
- declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
94
- declare const onPostDeleted$1: EventDefinition<PostDeletedEnvelope, "wix.blog.v3.post_deleted">;
95
100
  declare const onPostLiked$1: EventDefinition<PostLikedEnvelope, "wix.blog.v3.post_liked">;
96
101
  declare const onPostUnliked$1: EventDefinition<PostUnlikedEnvelope, "wix.blog.v3.post_unliked">;
102
+ declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
103
+ declare const onPostDeleted$1: EventDefinition<PostDeletedEnvelope, "wix.blog.v3.post_deleted">;
97
104
  declare const onPostUpdated$1: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
98
105
 
99
106
  declare const queryPostCountStats: MaybeContext<BuildRESTFunction<typeof queryPostCountStats$1> & typeof queryPostCountStats$1>;
@@ -103,6 +110,10 @@ declare const getPostBySlug: MaybeContext<BuildRESTFunction<typeof getPostBySlug
103
110
  declare const listPosts: MaybeContext<BuildRESTFunction<typeof listPosts$1> & typeof listPosts$1>;
104
111
  declare const queryPosts: MaybeContext<BuildRESTFunction<typeof queryPosts$1> & typeof queryPosts$1>;
105
112
  declare const getPostMetrics: MaybeContext<BuildRESTFunction<typeof getPostMetrics$1> & typeof getPostMetrics$1>;
113
+ /** */
114
+ declare const onPostLiked: BuildEventDefinition<typeof onPostLiked$1> & typeof onPostLiked$1;
115
+ /** */
116
+ declare const onPostUnliked: BuildEventDefinition<typeof onPostUnliked$1> & typeof onPostUnliked$1;
106
117
  /**
107
118
  * Triggered when a post is created.
108
119
  */
@@ -111,17 +122,9 @@ declare const onPostCreated: BuildEventDefinition<typeof onPostCreated$1> & type
111
122
  * Triggered when a post is deleted.
112
123
  */
113
124
  declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & typeof onPostDeleted$1;
114
- /**
115
- * Triggered when a post is liked.
116
- */
117
- declare const onPostLiked: BuildEventDefinition<typeof onPostLiked$1> & typeof onPostLiked$1;
118
- /**
119
- * Triggered when a post is unliked.
120
- */
121
- declare const onPostUnliked: BuildEventDefinition<typeof onPostUnliked$1> & typeof onPostUnliked$1;
122
125
  /**
123
126
  * Triggered when a post is updated.
124
127
  */
125
128
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
126
129
 
127
- 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 };
@@ -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"]
1411
- )?.post;
1431
+ ["post.richContent", "post.rich_content"]
1432
+ );
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"]
1484
+ ["post.richContent", "post.rich_content"]
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"]
1548
+ ["posts.richContent", "posts.rich_content"]
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"]
1623
+ ["posts.richContent", "posts.rich_content"]
1603
1624
  );
1604
1625
  return {
1605
1626
  items: transformedData?.posts,
@@ -1694,6 +1715,32 @@ 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
+ ["entity.rich_content"]
1729
+ )
1730
+ )();
1731
+ var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1732
+ "wix.blog.v3.post_unliked",
1733
+ true,
1734
+ (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
1735
+ (0, import_transform_paths3.transformPaths)(event, [
1736
+ {
1737
+ transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1738
+ paths: [{ path: "metadata.eventTime" }]
1739
+ }
1740
+ ]),
1741
+ ["entity.rich_content"]
1742
+ )
1743
+ )();
1697
1744
  var onPostCreated = (0, import_sdk_types.EventDefinition)(
1698
1745
  "wix.blog.v3.post_created",
1699
1746
  true,
@@ -1766,7 +1813,8 @@ var onPostCreated = (0, import_sdk_types.EventDefinition)(
1766
1813
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1767
1814
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1768
1815
  }
1769
- ])
1816
+ ]),
1817
+ ["entity.rich_content"]
1770
1818
  )
1771
1819
  )();
1772
1820
  var onPostDeleted = (0, import_sdk_types.EventDefinition)(
@@ -1841,31 +1889,8 @@ var onPostDeleted = (0, import_sdk_types.EventDefinition)(
1841
1889
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1842
1890
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1843
1891
  }
1844
- ])
1845
- )
1846
- )();
1847
- var onPostLiked = (0, import_sdk_types.EventDefinition)(
1848
- "wix.blog.v3.post_liked",
1849
- true,
1850
- (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
1851
- (0, import_transform_paths3.transformPaths)(event, [
1852
- {
1853
- transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1854
- paths: [{ path: "metadata.eventTime" }]
1855
- }
1856
- ])
1857
- )
1858
- )();
1859
- var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1860
- "wix.blog.v3.post_unliked",
1861
- true,
1862
- (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
1863
- (0, import_transform_paths3.transformPaths)(event, [
1864
- {
1865
- transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1866
- paths: [{ path: "metadata.eventTime" }]
1867
- }
1868
- ])
1892
+ ]),
1893
+ ["entity.rich_content"]
1869
1894
  )
1870
1895
  )();
1871
1896
  var onPostUpdated = (0, import_sdk_types.EventDefinition)(
@@ -1940,7 +1965,8 @@ var onPostUpdated = (0, import_sdk_types.EventDefinition)(
1940
1965
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
1941
1966
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1942
1967
  }
1943
- ])
1968
+ ]),
1969
+ ["entity.rich_content"]
1944
1970
  )
1945
1971
  )();
1946
1972
 
@@ -1954,10 +1980,10 @@ var getPostBySlug4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(
1954
1980
  var listPosts4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(listPosts3);
1955
1981
  var queryPosts4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(queryPosts3);
1956
1982
  var getPostMetrics4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getPostMetrics3);
1957
- var onPostCreated2 = (0, import_event_definition_modules.createEventModule)(onPostCreated);
1958
- var onPostDeleted2 = (0, import_event_definition_modules.createEventModule)(onPostDeleted);
1959
1983
  var onPostLiked2 = (0, import_event_definition_modules.createEventModule)(onPostLiked);
1960
1984
  var onPostUnliked2 = (0, import_event_definition_modules.createEventModule)(onPostUnliked);
1985
+ var onPostCreated2 = (0, import_event_definition_modules.createEventModule)(onPostCreated);
1986
+ var onPostDeleted2 = (0, import_event_definition_modules.createEventModule)(onPostDeleted);
1961
1987
  var onPostUpdated2 = (0, import_event_definition_modules.createEventModule)(onPostUpdated);
1962
1988
  // Annotate the CommonJS export names for ESM import in node:
1963
1989
  0 && (module.exports = {