@wix/auto_sdk_blog_posts 1.0.185 → 1.0.187

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, 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, 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, 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, ViewPostResponse, 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, 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, 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, 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
  }
@@ -68,6 +72,16 @@ interface GetPostMetricsSignature {
68
72
  */
69
73
  (postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 1>>;
70
74
  }
75
+ declare function viewPost$1(httpClient: HttpClient): ViewPostSignature;
76
+ interface ViewPostSignature {
77
+ /**
78
+ * Increments a post's view count.
79
+ *
80
+ * Call this method when a site visitor views a published post. The response returns the post's updated total number of views.
81
+ * @param - Post ID.
82
+ */
83
+ (postId: string): Promise<NonNullablePaths<ViewPostResponse, `views`, 0>>;
84
+ }
71
85
  declare const onPostLiked$1: EventDefinition<PostLikedEnvelope, "wix.blog.v3.post_liked">;
72
86
  declare const onPostUnliked$1: EventDefinition<PostUnlikedEnvelope, "wix.blog.v3.post_unliked">;
73
87
  declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
@@ -84,6 +98,7 @@ declare const getPost: MaybeContext<BuildRESTFunction<typeof getPost$1> & typeof
84
98
  declare const getPostBySlug: MaybeContext<BuildRESTFunction<typeof getPostBySlug$1> & typeof getPostBySlug$1>;
85
99
  declare const listPosts: MaybeContext<BuildRESTFunction<typeof listPosts$1> & typeof listPosts$1>;
86
100
  declare const getPostMetrics: MaybeContext<BuildRESTFunction<typeof getPostMetrics$1> & typeof getPostMetrics$1>;
101
+ declare const viewPost: MaybeContext<BuildRESTFunction<typeof viewPost$1> & typeof viewPost$1>;
87
102
  declare const queryPosts: MaybeContext<BuildRESTFunction<typeof customQueryPosts> & typeof customQueryPosts>;
88
103
  /** */
89
104
  declare const onPostLiked: BuildEventDefinition<typeof onPostLiked$1> & typeof onPostLiked$1;
@@ -102,4 +117,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
102
117
  */
103
118
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
104
119
 
105
- export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostQuery, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
120
+ 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 };
@@ -1097,6 +1097,27 @@ function getPostMetrics(payload) {
1097
1097
  }
1098
1098
  return __getPostMetrics;
1099
1099
  }
1100
+ function viewPost(payload) {
1101
+ function __viewPost({ host }) {
1102
+ const metadata = {
1103
+ entityFqdn: "wix.blog.v3.post",
1104
+ method: "POST",
1105
+ methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.ViewPost",
1106
+ packageName: PACKAGE_NAME,
1107
+ migrationOptions: {
1108
+ optInTransformResponse: true
1109
+ },
1110
+ url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
1111
+ protoPath: "/v3/posts/{postId}/view",
1112
+ data: payload,
1113
+ host
1114
+ }),
1115
+ data: payload
1116
+ };
1117
+ return metadata;
1118
+ }
1119
+ return __viewPost;
1120
+ }
1100
1121
 
1101
1122
  // src/blog-v3-post-posts.universal.ts
1102
1123
  import { transformRESTImageToSDKImage } from "@wix/sdk-runtime/transformations/image";
@@ -1777,8 +1798,8 @@ async function getPost2(postId, options) {
1777
1798
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1778
1799
  }
1779
1800
  ]),
1780
- ["post.richContent"]
1781
- )?.post;
1801
+ ["post.richContent", "post.rich_content"]
1802
+ );
1782
1803
  } catch (err) {
1783
1804
  const transformedError = sdkTransformError(
1784
1805
  err,
@@ -1825,7 +1846,7 @@ async function getPostBySlug2(slug, options) {
1825
1846
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1826
1847
  }
1827
1848
  ]),
1828
- ["post.richContent"]
1849
+ ["post.richContent", "post.rich_content"]
1829
1850
  );
1830
1851
  } catch (err) {
1831
1852
  const transformedError = sdkTransformError(
@@ -1884,7 +1905,7 @@ async function listPosts2(options) {
1884
1905
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1885
1906
  }
1886
1907
  ]),
1887
- ["posts.richContent"]
1908
+ ["posts.richContent", "posts.rich_content"]
1888
1909
  );
1889
1910
  } catch (err) {
1890
1911
  const transformedError = sdkTransformError(
@@ -1954,7 +1975,7 @@ function queryPosts2(options) {
1954
1975
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1955
1976
  }
1956
1977
  ]),
1957
- ["posts.richContent"]
1978
+ ["posts.richContent", "posts.rich_content"]
1958
1979
  );
1959
1980
  return {
1960
1981
  items: transformedData?.posts,
@@ -2002,7 +2023,7 @@ async function typedQueryPosts(query, options) {
2002
2023
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
2003
2024
  }
2004
2025
  ]),
2005
- ["posts.richContent"]
2026
+ ["posts.richContent", "posts.rich_content"]
2006
2027
  );
2007
2028
  } catch (err) {
2008
2029
  const transformedError = sdkTransformError(
@@ -2044,6 +2065,29 @@ async function getPostMetrics2(postId) {
2044
2065
  throw transformedError;
2045
2066
  }
2046
2067
  }
2068
+ async function viewPost2(postId) {
2069
+ const { httpClient, sideEffects } = arguments[1];
2070
+ const payload = renameKeysFromSDKRequestToRESTRequest({ postId }, []);
2071
+ const reqOpts = viewPost(payload);
2072
+ sideEffects?.onSiteCall?.();
2073
+ try {
2074
+ const result = await httpClient.request(reqOpts);
2075
+ sideEffects?.onSuccess?.(result);
2076
+ return renameKeysFromRESTResponseToSDKResponse(result.data, []);
2077
+ } catch (err) {
2078
+ const transformedError = sdkTransformError(
2079
+ err,
2080
+ {
2081
+ spreadPathsToArguments: {},
2082
+ explicitPathsToArguments: { postId: "$[0]" },
2083
+ singleArgumentUnchanged: false
2084
+ },
2085
+ ["postId"]
2086
+ );
2087
+ sideEffects?.onError?.(err);
2088
+ throw transformedError;
2089
+ }
2090
+ }
2047
2091
 
2048
2092
  // src/blog-v3-post-posts.public.ts
2049
2093
  function queryPostCountStats3(httpClient) {
@@ -2105,6 +2149,13 @@ function getPostMetrics3(httpClient) {
2105
2149
  { httpClient }
2106
2150
  );
2107
2151
  }
2152
+ function viewPost3(httpClient) {
2153
+ return (postId) => viewPost2(
2154
+ postId,
2155
+ // @ts-ignore
2156
+ { httpClient }
2157
+ );
2158
+ }
2108
2159
  var onPostLiked = /* @__PURE__ */ EventDefinition(
2109
2160
  "wix.blog.v3.post_liked",
2110
2161
  true,
@@ -2114,7 +2165,8 @@ var onPostLiked = /* @__PURE__ */ EventDefinition(
2114
2165
  transformFn: transformRESTTimestampToSDKTimestamp2,
2115
2166
  paths: [{ path: "metadata.eventTime" }]
2116
2167
  }
2117
- ])
2168
+ ]),
2169
+ ["entity.rich_content"]
2118
2170
  )
2119
2171
  )();
2120
2172
  var onPostUnliked = /* @__PURE__ */ EventDefinition(
@@ -2126,7 +2178,8 @@ var onPostUnliked = /* @__PURE__ */ EventDefinition(
2126
2178
  transformFn: transformRESTTimestampToSDKTimestamp2,
2127
2179
  paths: [{ path: "metadata.eventTime" }]
2128
2180
  }
2129
- ])
2181
+ ]),
2182
+ ["entity.rich_content"]
2130
2183
  )
2131
2184
  )();
2132
2185
  var onPostCreated = /* @__PURE__ */ EventDefinition(
@@ -2287,7 +2340,8 @@ var onPostCreated = /* @__PURE__ */ EventDefinition(
2287
2340
  transformFn: transformRESTVideoV2ToSDKVideoV22,
2288
2341
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
2289
2342
  }
2290
- ])
2343
+ ]),
2344
+ ["entity.rich_content"]
2291
2345
  )
2292
2346
  )();
2293
2347
  var onPostDeleted = /* @__PURE__ */ EventDefinition(
@@ -2448,7 +2502,8 @@ var onPostDeleted = /* @__PURE__ */ EventDefinition(
2448
2502
  transformFn: transformRESTVideoV2ToSDKVideoV22,
2449
2503
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
2450
2504
  }
2451
- ])
2505
+ ]),
2506
+ ["entity.rich_content"]
2452
2507
  )
2453
2508
  )();
2454
2509
  var onPostUpdated = /* @__PURE__ */ EventDefinition(
@@ -2609,7 +2664,8 @@ var onPostUpdated = /* @__PURE__ */ EventDefinition(
2609
2664
  transformFn: transformRESTVideoV2ToSDKVideoV22,
2610
2665
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
2611
2666
  }
2612
- ])
2667
+ ]),
2668
+ ["entity.rich_content"]
2613
2669
  )
2614
2670
  )();
2615
2671
 
@@ -2634,6 +2690,7 @@ var getPost4 = /* @__PURE__ */ createRESTModule(getPost3);
2634
2690
  var getPostBySlug4 = /* @__PURE__ */ createRESTModule(getPostBySlug3);
2635
2691
  var listPosts4 = /* @__PURE__ */ createRESTModule(listPosts3);
2636
2692
  var getPostMetrics4 = /* @__PURE__ */ createRESTModule(getPostMetrics3);
2693
+ var viewPost4 = /* @__PURE__ */ createRESTModule(viewPost3);
2637
2694
  var queryPosts4 = /* @__PURE__ */ createRESTModule(customQueryPosts);
2638
2695
  var onPostLiked2 = /* @__PURE__ */ createEventModule(onPostLiked);
2639
2696
  var onPostUnliked2 = /* @__PURE__ */ createEventModule(onPostUnliked);
@@ -2724,6 +2781,7 @@ export {
2724
2781
  onPostUpdated2 as onPostUpdated,
2725
2782
  queryPostCountStats4 as queryPostCountStats,
2726
2783
  queryPosts4 as queryPosts,
2727
- utils
2784
+ utils,
2785
+ viewPost4 as viewPost
2728
2786
  };
2729
2787
  //# sourceMappingURL=index.mjs.map