@wix/auto_sdk_blog_posts 1.0.67 → 1.0.68

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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 };
@@ -27,186 +27,7 @@ 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 = {
31
- "api._api_base_domain_": [
32
- {
33
- srcPath: "/communities-blog-node-api",
34
- destPath: ""
35
- }
36
- ],
37
- "www._base_domain_": [
38
- {
39
- srcPath: "/_api/communities-blog-node-api",
40
- destPath: ""
41
- },
42
- {
43
- srcPath: "/_api/communities-blog-node-api/v3/posts",
44
- destPath: "/v3/posts"
45
- },
46
- {
47
- srcPath: "/_api/communities-blog-node-api/v2/stats",
48
- destPath: "/v2/stats"
49
- }
50
- ],
51
- "apps._base_domain_": [
52
- {
53
- srcPath: "/_api/communities-blog-node-api",
54
- destPath: ""
55
- },
56
- {
57
- srcPath: "/_api/communities-blog-node-api/v3/posts",
58
- destPath: "/v3/posts"
59
- },
60
- {
61
- srcPath: "/_api/communities-blog-node-api/v2/stats",
62
- destPath: "/v2/stats"
63
- }
64
- ],
65
- _: [
66
- {
67
- srcPath: "/_api/communities-blog-node-api",
68
- destPath: ""
69
- },
70
- {
71
- srcPath: "/_api/communities-blog-node-api/_api/blogs/this",
72
- destPath: "/_api/blogs/this"
73
- },
74
- {
75
- srcPath: "/_api/communities-blog-node-api/_api/categories",
76
- destPath: "/_api/categories"
77
- },
78
- {
79
- srcPath: "/_api/communities-blog-node-api/_api/site-properties",
80
- destPath: "/_api/site-properties"
81
- },
82
- {
83
- srcPath: "/_api/communities-blog-node-api/_api/posts/content",
84
- destPath: "/_api/posts/content"
85
- },
86
- {
87
- srcPath: "/_api/communities-blog-node-api/v3/posts",
88
- destPath: "/v3/posts"
89
- },
90
- {
91
- srcPath: "/_api/communities-blog-node-api/v2/stats",
92
- destPath: "/v2/stats"
93
- }
94
- ],
95
- "editor._base_domain_": [
96
- {
97
- srcPath: "/_api/communities-blog-node-api",
98
- destPath: ""
99
- }
100
- ],
101
- "blocks._base_domain_": [
102
- {
103
- srcPath: "/_api/communities-blog-node-api",
104
- destPath: ""
105
- }
106
- ],
107
- "create.editorx": [
108
- {
109
- srcPath: "/_api/communities-blog-node-api",
110
- destPath: ""
111
- }
112
- ],
113
- "*.dev.wix-code.com": [
114
- {
115
- srcPath: "/_api/communities-blog-node-api",
116
- destPath: ""
117
- }
118
- ],
119
- "*.pub.wix-code.com": [
120
- {
121
- srcPath: "/_api/communities-blog-node-api",
122
- destPath: ""
123
- }
124
- ],
125
- "bo._base_domain_": [
126
- {
127
- srcPath: "/_api/communities-blog-node-api",
128
- destPath: ""
129
- },
130
- {
131
- srcPath: "/_api/communities-blog-node-api",
132
- destPath: ""
133
- }
134
- ],
135
- "wixbo.ai": [
136
- {
137
- srcPath: "/_api/communities-blog-node-api",
138
- destPath: ""
139
- },
140
- {
141
- srcPath: "/_api/communities-blog-node-api",
142
- destPath: ""
143
- }
144
- ],
145
- "wix-bo.com": [
146
- {
147
- srcPath: "/_api/communities-blog-node-api",
148
- destPath: ""
149
- },
150
- {
151
- srcPath: "/_api/communities-blog-node-api",
152
- destPath: ""
153
- }
154
- ],
155
- "manage._base_domain_": [
156
- {
157
- srcPath: "/_api/communities-blog-node-api",
158
- destPath: ""
159
- }
160
- ],
161
- "social-blog._base_domain_": [
162
- {
163
- srcPath: "/_api/communities-blog-node-api",
164
- destPath: ""
165
- }
166
- ],
167
- "editor.wixapps.net": [
168
- {
169
- srcPath: "/_api/communities-blog-node-api",
170
- destPath: ""
171
- }
172
- ],
173
- "dev._base_domain_": [
174
- {
175
- srcPath: "/_api/communities-blog-node-api",
176
- destPath: ""
177
- }
178
- ],
179
- "www.wixapis.com": [
180
- {
181
- srcPath: "/blog/v2",
182
- destPath: "/v2"
183
- },
184
- {
185
- srcPath: "/blog/v3",
186
- destPath: "/v3"
187
- },
188
- {
189
- srcPath: "/v2/stats",
190
- destPath: "/v2/stats"
191
- },
192
- {
193
- srcPath: "/v3/posts",
194
- destPath: "/v3/posts"
195
- },
196
- {
197
- srcPath: "/blog/v3/posts",
198
- destPath: "/v3/posts"
199
- },
200
- {
201
- srcPath: "/blog/v2/stats",
202
- destPath: "/v2/stats"
203
- },
204
- {
205
- srcPath: "/_api/v3/posts",
206
- destPath: "/v3/posts"
207
- }
208
- ]
209
- };
30
+ const domainToMappings = {};
210
31
  return resolveUrl(Object.assign(opts, { domainToMappings }));
211
32
  }
212
33
  function resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl(opts) {
@@ -1375,8 +1196,8 @@ async function getPost2(postId, options) {
1375
1196
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1376
1197
  }
1377
1198
  ]),
1378
- ["post.richContent", "post.rich_content"]
1379
- );
1199
+ ["post.richContent"]
1200
+ )?.post;
1380
1201
  } catch (err) {
1381
1202
  const transformedError = sdkTransformError(
1382
1203
  err,
@@ -1428,7 +1249,7 @@ async function getPostBySlug2(slug, options) {
1428
1249
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1429
1250
  }
1430
1251
  ]),
1431
- ["post.richContent", "post.rich_content"]
1252
+ ["post.richContent"]
1432
1253
  );
1433
1254
  } catch (err) {
1434
1255
  const transformedError = sdkTransformError(
@@ -1492,7 +1313,7 @@ async function listPosts2(options) {
1492
1313
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1493
1314
  }
1494
1315
  ]),
1495
- ["posts.richContent", "posts.rich_content"]
1316
+ ["posts.richContent"]
1496
1317
  );
1497
1318
  } catch (err) {
1498
1319
  const transformedError = sdkTransformError(
@@ -1567,7 +1388,7 @@ function queryPosts2(options) {
1567
1388
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1568
1389
  }
1569
1390
  ]),
1570
- ["posts.richContent", "posts.rich_content"]
1391
+ ["posts.richContent"]
1571
1392
  );
1572
1393
  return {
1573
1394
  items: transformedData?.posts,
@@ -1671,8 +1492,7 @@ var onPostLiked = EventDefinition(
1671
1492
  transformFn: transformRESTTimestampToSDKTimestamp2,
1672
1493
  paths: [{ path: "metadata.eventTime" }]
1673
1494
  }
1674
- ]),
1675
- ["entity.rich_content"]
1495
+ ])
1676
1496
  )
1677
1497
  )();
1678
1498
  var onPostUnliked = EventDefinition(
@@ -1684,8 +1504,7 @@ var onPostUnliked = EventDefinition(
1684
1504
  transformFn: transformRESTTimestampToSDKTimestamp2,
1685
1505
  paths: [{ path: "metadata.eventTime" }]
1686
1506
  }
1687
- ]),
1688
- ["entity.rich_content"]
1507
+ ])
1689
1508
  )
1690
1509
  )();
1691
1510
  var onPostCreated = EventDefinition(
@@ -1760,8 +1579,7 @@ var onPostCreated = EventDefinition(
1760
1579
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1761
1580
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1762
1581
  }
1763
- ]),
1764
- ["entity.rich_content"]
1582
+ ])
1765
1583
  )
1766
1584
  )();
1767
1585
  var onPostDeleted = EventDefinition(
@@ -1836,8 +1654,7 @@ var onPostDeleted = EventDefinition(
1836
1654
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1837
1655
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1838
1656
  }
1839
- ]),
1840
- ["entity.rich_content"]
1657
+ ])
1841
1658
  )
1842
1659
  )();
1843
1660
  var onPostUpdated = EventDefinition(
@@ -1912,8 +1729,7 @@ var onPostUpdated = EventDefinition(
1912
1729
  transformFn: transformRESTVideoV2ToSDKVideoV22,
1913
1730
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
1914
1731
  }
1915
- ]),
1916
- ["entity.rich_content"]
1732
+ ])
1917
1733
  )
1918
1734
  )();
1919
1735