@wix/auto_sdk_blog_posts 1.0.193 → 1.0.195

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, GetPostMetricsResponse, ViewPostResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope, PostQuery, QueryPostsOptions, typedQueryPosts, PostsQueryBuilder } from './index.typings.mjs';
3
- export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest, GetPostResponse, GetPostsSort, GetPostsSortWithLiterals, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListItemNodeData, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, 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, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, PostCategoriesUpdated, PostCount, PostCountInfo, PostCountPerMonth, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostQuerySpec, 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, SectionDivider, SeoSchema, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia, utils } from './index.typings.mjs';
2
+ import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, GetPostMetricsResponse, ViewPostResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope, PostQuery, QueryPostsOptions, typedQueryPosts, PostsQueryBuilder } from './index.typings.mjs';
3
+ export { AccountInfo, AccountInfoMetadata, ActionEvent, AddressLocation, Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerOriginPresenceOneOf, BannerPosition, BannerPositionWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, CommonQueryWithEntityContext, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, EventMetadata, Field, FieldWithLiterals, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest, GetPostsSort, GetPostsSortWithLiterals, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListItemNodeData, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, 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, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollSettings, Position, PositionWithLiterals, Post, PostCategoriesUpdated, PostCount, PostCountInfo, PostCountPerMonth, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostFieldFieldWithLiterals, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostQuerySpec, 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, SectionDivider, SeoSchema, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, Spoiler, SpoilerData, Status, StatusWithLiterals, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Tag, Target, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, VideoResolution, ViewMode, ViewModeWithLiterals, ViewPostRequest, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixMedia, utils } 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`, 2>>;
@@ -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`, 0>>;
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` | `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`, 4>>;
36
+ (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `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`, 5>>;
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.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`, 5>>;
48
51
  }
@@ -55,6 +58,7 @@ 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}.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`, 4>>;
60
64
  }
@@ -115,4 +119,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
115
119
  */
116
120
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
117
121
 
118
- export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostQuery, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, ViewPostResponse, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, viewPost };
122
+ export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostQuery, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, ViewPostResponse, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, viewPost };
@@ -1527,6 +1527,7 @@ var Origin = /* @__PURE__ */ ((Origin2) => {
1527
1527
  var BannerPosition = /* @__PURE__ */ ((BannerPosition2) => {
1528
1528
  BannerPosition2["TOP"] = "TOP";
1529
1529
  BannerPosition2["BOTTOM"] = "BOTTOM";
1530
+ BannerPosition2["PAYWALL"] = "PAYWALL";
1530
1531
  return BannerPosition2;
1531
1532
  })(BannerPosition || {});
1532
1533
  var LayerEffect = /* @__PURE__ */ ((LayerEffect2) => {
@@ -1680,17 +1681,14 @@ var Order = /* @__PURE__ */ ((Order2) => {
1680
1681
  Order2["NEWEST"] = "NEWEST";
1681
1682
  return Order2;
1682
1683
  })(Order || {});
1683
- var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1684
- GetPostsSort2["FEED"] = "FEED";
1685
- GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1686
- GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1687
- GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1688
- GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1689
- GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1690
- GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1691
- GetPostsSort2["RATING"] = "RATING";
1692
- return GetPostsSort2;
1693
- })(GetPostsSort || {});
1684
+ var Field = /* @__PURE__ */ ((Field2) => {
1685
+ Field2["UNKNOWN"] = "UNKNOWN";
1686
+ Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1687
+ Field2["LIKE_COUNT"] = "LIKE_COUNT";
1688
+ Field2["VIEW_COUNT"] = "VIEW_COUNT";
1689
+ Field2["RATING_COUNT"] = "RATING_COUNT";
1690
+ return Field2;
1691
+ })(Field || {});
1694
1692
  var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1695
1693
  PostFieldField2["UNKNOWN"] = "UNKNOWN";
1696
1694
  PostFieldField2["COUNTERS"] = "COUNTERS";
@@ -1714,14 +1712,17 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1714
1712
  PostFieldField2["IMAGE"] = "IMAGE";
1715
1713
  return PostFieldField2;
1716
1714
  })(PostFieldField || {});
1717
- var Field = /* @__PURE__ */ ((Field2) => {
1718
- Field2["UNKNOWN"] = "UNKNOWN";
1719
- Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1720
- Field2["LIKE_COUNT"] = "LIKE_COUNT";
1721
- Field2["VIEW_COUNT"] = "VIEW_COUNT";
1722
- Field2["RATING_COUNT"] = "RATING_COUNT";
1723
- return Field2;
1724
- })(Field || {});
1715
+ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1716
+ GetPostsSort2["FEED"] = "FEED";
1717
+ GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1718
+ GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1719
+ GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1720
+ GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1721
+ GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1722
+ GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1723
+ GetPostsSort2["RATING"] = "RATING";
1724
+ return GetPostsSort2;
1725
+ })(GetPostsSort || {});
1725
1726
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
1726
1727
  SortOrder2["ASC"] = "ASC";
1727
1728
  SortOrder2["DESC"] = "DESC";
@@ -1817,8 +1818,8 @@ async function getPost2(postId, options) {
1817
1818
  paths: TRANSFORM_PATHS_22
1818
1819
  }
1819
1820
  ]),
1820
- ["post.richContent"]
1821
- )?.post;
1821
+ ["post.richContent", "post.rich_content"]
1822
+ );
1822
1823
  } catch (err) {
1823
1824
  const transformedError = sdkTransformError(
1824
1825
  err,
@@ -1862,7 +1863,7 @@ async function getPostBySlug2(slug, options) {
1862
1863
  paths: TRANSFORM_PATHS_22
1863
1864
  }
1864
1865
  ]),
1865
- ["post.richContent"]
1866
+ ["post.richContent", "post.rich_content"]
1866
1867
  );
1867
1868
  } catch (err) {
1868
1869
  const transformedError = sdkTransformError(
@@ -1918,7 +1919,7 @@ async function listPosts2(options) {
1918
1919
  paths: TRANSFORM_PATHS_52
1919
1920
  }
1920
1921
  ]),
1921
- ["posts.richContent"]
1922
+ ["posts.richContent", "posts.rich_content"]
1922
1923
  );
1923
1924
  } catch (err) {
1924
1925
  const transformedError = sdkTransformError(
@@ -1985,7 +1986,7 @@ function queryPosts2(options) {
1985
1986
  paths: TRANSFORM_PATHS_52
1986
1987
  }
1987
1988
  ]),
1988
- ["posts.richContent"]
1989
+ ["posts.richContent", "posts.rich_content"]
1989
1990
  );
1990
1991
  return {
1991
1992
  items: transformedData?.posts,
@@ -2030,7 +2031,7 @@ async function typedQueryPosts(query, options) {
2030
2031
  paths: TRANSFORM_PATHS_52
2031
2032
  }
2032
2033
  ]),
2033
- ["posts.richContent"]
2034
+ ["posts.richContent", "posts.rich_content"]
2034
2035
  );
2035
2036
  } catch (err) {
2036
2037
  const transformedError = sdkTransformError(
@@ -2467,7 +2468,8 @@ var onPostLiked = /* @__PURE__ */ EventDefinition(
2467
2468
  transformFn: transformRESTTimestampToSDKTimestamp2,
2468
2469
  paths: TRANSFORM_PATHS_03
2469
2470
  }
2470
- ])
2471
+ ]),
2472
+ ["entity.rich_content"]
2471
2473
  )
2472
2474
  )();
2473
2475
  var onPostUnliked = /* @__PURE__ */ EventDefinition(
@@ -2479,7 +2481,8 @@ var onPostUnliked = /* @__PURE__ */ EventDefinition(
2479
2481
  transformFn: transformRESTTimestampToSDKTimestamp2,
2480
2482
  paths: TRANSFORM_PATHS_03
2481
2483
  }
2482
- ])
2484
+ ]),
2485
+ ["entity.rich_content"]
2483
2486
  )
2484
2487
  )();
2485
2488
  var onPostCreated = /* @__PURE__ */ EventDefinition(
@@ -2511,7 +2514,8 @@ var onPostCreated = /* @__PURE__ */ EventDefinition(
2511
2514
  transformFn: transformRESTVideoV2ToSDKVideoV22,
2512
2515
  paths: TRANSFORM_PATHS_62
2513
2516
  }
2514
- ])
2517
+ ]),
2518
+ ["entity.rich_content"]
2515
2519
  )
2516
2520
  )();
2517
2521
  var onPostDeleted = /* @__PURE__ */ EventDefinition(
@@ -2543,7 +2547,8 @@ var onPostDeleted = /* @__PURE__ */ EventDefinition(
2543
2547
  transformFn: transformRESTVideoV2ToSDKVideoV22,
2544
2548
  paths: TRANSFORM_PATHS_62
2545
2549
  }
2546
- ])
2550
+ ]),
2551
+ ["entity.rich_content"]
2547
2552
  )
2548
2553
  )();
2549
2554
  var onPostUpdated = /* @__PURE__ */ EventDefinition(
@@ -2575,7 +2580,8 @@ var onPostUpdated = /* @__PURE__ */ EventDefinition(
2575
2580
  transformFn: transformRESTVideoV2ToSDKVideoV22,
2576
2581
  paths: TRANSFORM_PATHS_62
2577
2582
  }
2578
- ])
2583
+ ]),
2584
+ ["entity.rich_content"]
2579
2585
  )
2580
2586
  )();
2581
2587