@wix/auto_sdk_blog_posts 1.0.71 → 1.0.73

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,19 +1,18 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope } from './index.typings.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';
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';
4
4
 
5
5
  declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
6
6
  interface QueryPostCountStatsSignature {
7
7
  /**
8
8
  * Retrieves the number of published posts per month within a specified time range.
9
9
  *
10
- *
11
- * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
12
- *
13
- * You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
14
- *
15
- * >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
16
- * @param - Options specifying time frame, sort, and filter.
10
+ * The time range is set using the `rangeStart` and `months` properties.
11
+ * The time range always starts on the 1st day of the month set in `rangeStart` and
12
+ * includes the number of `months` following `rangeStart`.
13
+ * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
14
+ * the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
15
+ * > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
17
16
  * @returns Get Blog Post Count Stats response
18
17
  */
19
18
  (options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 4>>;
@@ -22,7 +21,6 @@ declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature
22
21
  interface GetTotalPostsSignature {
23
22
  /**
24
23
  * Retrieves the total amount of published posts of the blog.
25
- * @param - Language Options.
26
24
  */
27
25
  (options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 2>>;
28
26
  }
@@ -31,9 +29,9 @@ interface GetPostSignature {
31
29
  /**
32
30
  * Retrieves a post by the specified ID.
33
31
  * @param - Post ID.
34
- * @param - Options specifying which fields to return.
32
+ * @returns Retrieved post info.
35
33
  */
36
- (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
34
+ (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
37
35
  }
38
36
  declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
39
37
  interface GetPostBySlugSignature {
@@ -45,7 +43,6 @@ interface GetPostBySlugSignature {
45
43
  * the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
46
44
  * unless specified otherwise.
47
45
  * @param - Slug of the post to retrieve.
48
- * @param - Options specifying which fields to return.
49
46
  */
50
47
  (slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
51
48
  }
@@ -58,32 +55,28 @@ interface ListPostsSignature {
58
55
  * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
59
56
  * - `paging.limit` is `50`.
60
57
  * - `paging.offset` is `0`.
61
- * @param - Sort, filter, and paging options.
62
58
  */
63
59
  (options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.coverMedia.enabled` | `posts.${number}.coverMedia.displayed` | `posts.${number}.coverMedia.custom` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges` | `metaData.count` | `metaData.offset` | `metaData.total`, 6>>;
64
60
  }
65
61
  declare function queryPosts$1(httpClient: HttpClient): QueryPostsSignature;
66
62
  interface QueryPostsSignature {
67
63
  /**
68
- * Creates a query to retrieve a list of posts.
69
- *
70
- *
71
- * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
72
- *
73
- * The returned object contains the query definition which is typically used to run the query using the `find()` function.
64
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
74
65
  *
75
- * You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
76
- *
77
- * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
78
- * + `limit(50)`
79
- * + `descending('firstPublishedDate')`
80
- *
81
- * Note that the default limit is `'50'`, but the max limit is `'100'`.
66
+ * Query Posts runs with these defaults, which you can override:
67
+ * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
68
+ * - `paging.limit` is `50`.
69
+ * - `paging.offset` is `0`.
82
70
  *
83
- * To learn how to query posts, refer to the table below.
71
+ * For field support for filters and sorting, see
72
+ * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
84
73
  *
85
- * The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
86
- * @param - Options specifying which fields to return.
74
+ * To learn about working with _Query_ endpoints, see
75
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
76
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
77
+ * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
78
+ * For a detailed list of supported filters and sortable fields, see
79
+ * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
87
80
  */
88
81
  (options?: QueryPostsOptions): PostsQueryBuilder;
89
82
  }
@@ -127,4 +120,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
127
120
  */
128
121
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
129
122
 
130
- export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
123
+ export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
@@ -33,18 +33,6 @@ function resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl(opts)
33
33
  srcPath: "/_api/communities-blog-node-api/v3/posts",
34
34
  destPath: "/v3/posts"
35
35
  }
36
- ],
37
- "www._base_domain_": [
38
- {
39
- srcPath: "/_api/communities-blog-node-api/v3/posts",
40
- destPath: "/v3/posts"
41
- }
42
- ],
43
- "www.wixapis.com": [
44
- {
45
- srcPath: "/_api/v3/posts",
46
- destPath: "/v3/posts"
47
- }
48
36
  ]
49
37
  };
50
38
  return resolveUrl(Object.assign(opts, { domainToMappings }));
@@ -62,6 +50,10 @@ function resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl(opt
62
50
  srcPath: "/_api/communities-blog-node-api",
63
51
  destPath: ""
64
52
  },
53
+ {
54
+ srcPath: "/_api/communities-blog-node-api/v3/posts",
55
+ destPath: "/v3/posts"
56
+ },
65
57
  {
66
58
  srcPath: "/_api/communities-blog-node-api/v2/stats",
67
59
  destPath: "/v2/stats"
@@ -215,6 +207,10 @@ function resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl(opt
215
207
  {
216
208
  srcPath: "/blog/v2/stats",
217
209
  destPath: "/v2/stats"
210
+ },
211
+ {
212
+ srcPath: "/_api/v3/posts",
213
+ destPath: "/v3/posts"
218
214
  }
219
215
  ]
220
216
  };
@@ -1203,8 +1199,8 @@ async function getPost2(postId, options) {
1203
1199
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1204
1200
  }
1205
1201
  ]),
1206
- ["post.richContent", "post.rich_content"]
1207
- );
1202
+ ["post.richContent"]
1203
+ )?.post;
1208
1204
  } catch (err) {
1209
1205
  const transformedError = sdkTransformError(
1210
1206
  err,
@@ -1256,7 +1252,7 @@ async function getPostBySlug2(slug, options) {
1256
1252
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1257
1253
  }
1258
1254
  ]),
1259
- ["post.richContent", "post.rich_content"]
1255
+ ["post.richContent"]
1260
1256
  );
1261
1257
  } catch (err) {
1262
1258
  const transformedError = sdkTransformError(
@@ -1320,7 +1316,7 @@ async function listPosts2(options) {
1320
1316
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1321
1317
  }
1322
1318
  ]),
1323
- ["posts.richContent", "posts.rich_content"]
1319
+ ["posts.richContent"]
1324
1320
  );
1325
1321
  } catch (err) {
1326
1322
  const transformedError = sdkTransformError(
@@ -1395,7 +1391,7 @@ function queryPosts2(options) {
1395
1391
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1396
1392
  }
1397
1393
  ]),
1398
- ["posts.richContent", "posts.rich_content"]
1394
+ ["posts.richContent"]
1399
1395
  );
1400
1396
  return {
1401
1397
  items: transformedData?.posts,
@@ -1499,8 +1495,7 @@ var onPostLiked = EventDefinition(
1499
1495
  transformFn: transformRESTTimestampToSDKTimestamp2,
1500
1496
  paths: [{ path: "metadata.eventTime" }]
1501
1497
  }
1502
- ]),
1503
- ["entity.rich_content"]
1498
+ ])
1504
1499
  )
1505
1500
  )();
1506
1501
  var onPostUnliked = EventDefinition(
@@ -1512,8 +1507,7 @@ var onPostUnliked = EventDefinition(
1512
1507
  transformFn: transformRESTTimestampToSDKTimestamp2,
1513
1508
  paths: [{ path: "metadata.eventTime" }]
1514
1509
  }
1515
- ]),
1516
- ["entity.rich_content"]
1510
+ ])
1517
1511
  )
1518
1512
  )();
1519
1513
  var onPostCreated = EventDefinition(
@@ -1588,8 +1582,7 @@ var onPostCreated = EventDefinition(
1588
1582
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1589
1583
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1590
1584
  }
1591
- ]),
1592
- ["entity.rich_content"]
1585
+ ])
1593
1586
  )
1594
1587
  )();
1595
1588
  var onPostDeleted = EventDefinition(
@@ -1664,8 +1657,7 @@ var onPostDeleted = EventDefinition(
1664
1657
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1665
1658
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1666
1659
  }
1667
- ]),
1668
- ["entity.rich_content"]
1660
+ ])
1669
1661
  )
1670
1662
  )();
1671
1663
  var onPostUpdated = EventDefinition(
@@ -1740,8 +1732,7 @@ var onPostUpdated = EventDefinition(
1740
1732
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1741
1733
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1742
1734
  }
1743
- ]),
1744
- ["entity.rich_content"]
1735
+ ])
1745
1736
  )
1746
1737
  )();
1747
1738