@wix/auto_sdk_blog_posts 1.0.68 → 1.0.69

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, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope } from './index.typings.mjs';
3
- export { ActionEvent, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostMetricsRequest, GetPostRequest, 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.mjs';
2
+ import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope } from './index.typings.mjs';
3
+ export { ActionEvent, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostMetricsRequest, GetPostRequest, GetPostTemplatesSort, GetPostTemplatesSortWithLiterals, GetPostsSort, GetPostsSortWithLiterals, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImagePosition, ImagePositionWithLiterals, ImageStyles, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, ModerationStatusStatusWithLiterals, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderWithLiterals, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, Placement, PlacementWithLiterals, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, PricingData, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsRequestOrderWithLiterals, QueryPublicationsCountStatsResponse, Reactions, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RestoreInfo, RibbonStyles, RichContent, Scaling, ScalingWithLiterals, ScheduledPostPublished, SeoSchema, Settings, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewPostResponse, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia } from './index.typings.mjs';
4
4
 
5
5
  declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
6
6
  interface QueryPostCountStatsSignature {
7
7
  /**
8
8
  * Retrieves the number of published posts per month within a specified time range.
9
9
  *
10
- * The time range is set using the `rangeStart` and `months` properties.
11
- * The time range always starts on the 1st day of the month set in `rangeStart` and
12
- * includes the number of `months` following `rangeStart`.
13
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
14
- * the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
15
- * > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
10
+ *
11
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
12
+ *
13
+ * You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
14
+ *
15
+ * >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
16
+ * @param - Options specifying time frame, sort, and filter.
16
17
  * @returns Get Blog Post Count Stats response
17
18
  */
18
19
  (options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 4>>;
@@ -21,6 +22,7 @@ declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature
21
22
  interface GetTotalPostsSignature {
22
23
  /**
23
24
  * Retrieves the total amount of published posts of the blog.
25
+ * @param - Language Options.
24
26
  */
25
27
  (options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 2>>;
26
28
  }
@@ -29,9 +31,9 @@ interface GetPostSignature {
29
31
  /**
30
32
  * Retrieves a post by the specified ID.
31
33
  * @param - Post ID.
32
- * @returns Retrieved post info.
34
+ * @param - Options specifying which fields to return.
33
35
  */
34
- (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
36
+ (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
35
37
  }
36
38
  declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
37
39
  interface GetPostBySlugSignature {
@@ -43,6 +45,7 @@ interface GetPostBySlugSignature {
43
45
  * the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
44
46
  * unless specified otherwise.
45
47
  * @param - Slug of the post to retrieve.
48
+ * @param - Options specifying which fields to return.
46
49
  */
47
50
  (slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
48
51
  }
@@ -55,28 +58,32 @@ interface ListPostsSignature {
55
58
  * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
56
59
  * - `paging.limit` is `50`.
57
60
  * - `paging.offset` is `0`.
61
+ * @param - Sort, filter, and paging options.
58
62
  */
59
63
  (options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.coverMedia.enabled` | `posts.${number}.coverMedia.displayed` | `posts.${number}.coverMedia.custom` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges` | `metaData.count` | `metaData.offset` | `metaData.total`, 6>>;
60
64
  }
61
65
  declare function queryPosts$1(httpClient: HttpClient): QueryPostsSignature;
62
66
  interface QueryPostsSignature {
63
67
  /**
64
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
68
+ * Creates a query to retrieve a list of posts.
65
69
  *
66
- * Query Posts runs with these defaults, which you can override:
67
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
68
- * - `paging.limit` is `50`.
69
- * - `paging.offset` is `0`.
70
70
  *
71
- * For field support for filters and sorting, see
72
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
71
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
72
+ *
73
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
74
+ *
75
+ * You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
76
+ *
77
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
78
+ * + `limit(50)`
79
+ * + `descending('firstPublishedDate')`
80
+ *
81
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
82
+ *
83
+ * To learn how to query posts, refer to the table below.
73
84
  *
74
- * To learn about working with _Query_ endpoints, see
75
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
76
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
77
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
78
- * For a detailed list of supported filters and sortable fields, see
79
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
85
+ * The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
86
+ * @param - Options specifying which fields to return.
80
87
  */
81
88
  (options?: QueryPostsOptions): PostsQueryBuilder;
82
89
  }
@@ -120,4 +127,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
120
127
  */
121
128
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
122
129
 
123
- export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
130
+ export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
@@ -27,7 +27,14 @@ import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transform
27
27
  import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
28
28
  import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
29
29
  function resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl(opts) {
30
- const domainToMappings = {};
30
+ const domainToMappings = {
31
+ "www._base_domain_": [
32
+ {
33
+ srcPath: "/_api/communities-blog-node-api/v3/posts",
34
+ destPath: "/v3/posts"
35
+ }
36
+ ]
37
+ };
31
38
  return resolveUrl(Object.assign(opts, { domainToMappings }));
32
39
  }
33
40
  function resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl(opts) {
@@ -43,10 +50,6 @@ function resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl(opt
43
50
  srcPath: "/_api/communities-blog-node-api",
44
51
  destPath: ""
45
52
  },
46
- {
47
- srcPath: "/_api/communities-blog-node-api/v3/posts",
48
- destPath: "/v3/posts"
49
- },
50
53
  {
51
54
  srcPath: "/_api/communities-blog-node-api/v2/stats",
52
55
  destPath: "/v2/stats"
@@ -1196,8 +1199,8 @@ async function getPost2(postId, options) {
1196
1199
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1197
1200
  }
1198
1201
  ]),
1199
- ["post.richContent"]
1200
- )?.post;
1202
+ ["post.richContent", "post.rich_content"]
1203
+ );
1201
1204
  } catch (err) {
1202
1205
  const transformedError = sdkTransformError(
1203
1206
  err,
@@ -1249,7 +1252,7 @@ async function getPostBySlug2(slug, options) {
1249
1252
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1250
1253
  }
1251
1254
  ]),
1252
- ["post.richContent"]
1255
+ ["post.richContent", "post.rich_content"]
1253
1256
  );
1254
1257
  } catch (err) {
1255
1258
  const transformedError = sdkTransformError(
@@ -1313,7 +1316,7 @@ async function listPosts2(options) {
1313
1316
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1314
1317
  }
1315
1318
  ]),
1316
- ["posts.richContent"]
1319
+ ["posts.richContent", "posts.rich_content"]
1317
1320
  );
1318
1321
  } catch (err) {
1319
1322
  const transformedError = sdkTransformError(
@@ -1388,7 +1391,7 @@ function queryPosts2(options) {
1388
1391
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1389
1392
  }
1390
1393
  ]),
1391
- ["posts.richContent"]
1394
+ ["posts.richContent", "posts.rich_content"]
1392
1395
  );
1393
1396
  return {
1394
1397
  items: transformedData?.posts,
@@ -1492,7 +1495,8 @@ var onPostLiked = EventDefinition(
1492
1495
  transformFn: transformRESTTimestampToSDKTimestamp2,
1493
1496
  paths: [{ path: "metadata.eventTime" }]
1494
1497
  }
1495
- ])
1498
+ ]),
1499
+ ["entity.rich_content"]
1496
1500
  )
1497
1501
  )();
1498
1502
  var onPostUnliked = EventDefinition(
@@ -1504,7 +1508,8 @@ var onPostUnliked = EventDefinition(
1504
1508
  transformFn: transformRESTTimestampToSDKTimestamp2,
1505
1509
  paths: [{ path: "metadata.eventTime" }]
1506
1510
  }
1507
- ])
1511
+ ]),
1512
+ ["entity.rich_content"]
1508
1513
  )
1509
1514
  )();
1510
1515
  var onPostCreated = EventDefinition(
@@ -1579,7 +1584,8 @@ var onPostCreated = EventDefinition(
1579
1584
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1580
1585
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1581
1586
  }
1582
- ])
1587
+ ]),
1588
+ ["entity.rich_content"]
1583
1589
  )
1584
1590
  )();
1585
1591
  var onPostDeleted = EventDefinition(
@@ -1654,7 +1660,8 @@ var onPostDeleted = EventDefinition(
1654
1660
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1655
1661
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1656
1662
  }
1657
- ])
1663
+ ]),
1664
+ ["entity.rich_content"]
1658
1665
  )
1659
1666
  )();
1660
1667
  var onPostUpdated = EventDefinition(
@@ -1729,7 +1736,8 @@ var onPostUpdated = EventDefinition(
1729
1736
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1730
1737
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1731
1738
  }
1732
- ])
1739
+ ]),
1740
+ ["entity.rich_content"]
1733
1741
  )
1734
1742
  )();
1735
1743