@wix/auto_sdk_blog_posts 1.0.143 → 1.0.145

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.
Files changed (49) hide show
  1. package/build/cjs/index.d.ts +15 -11
  2. package/build/cjs/index.js +54 -49
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +546 -543
  5. package/build/cjs/index.typings.js +44 -44
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +399 -399
  8. package/build/cjs/meta.js +38 -38
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +86 -88
  11. package/build/cjs/schemas.js +153 -151
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +15 -11
  14. package/build/es/index.mjs +54 -49
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +546 -543
  17. package/build/es/index.typings.mjs +44 -44
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +399 -399
  20. package/build/es/meta.mjs +38 -38
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +86 -88
  23. package/build/es/schemas.mjs +153 -151
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +15 -11
  26. package/build/internal/cjs/index.js +54 -49
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +546 -543
  29. package/build/internal/cjs/index.typings.js +44 -44
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +399 -399
  32. package/build/internal/cjs/meta.js +38 -38
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +86 -88
  35. package/build/internal/cjs/schemas.js +153 -151
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +15 -11
  38. package/build/internal/es/index.mjs +54 -49
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +546 -543
  41. package/build/internal/es/index.typings.mjs +44 -44
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +399 -399
  44. package/build/internal/es/meta.mjs +38 -38
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +86 -88
  47. package/build/internal/es/schemas.mjs +153 -151
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -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.js';
3
- export { AccountInfo, AccountInfoMetadata, ActionEvent, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerOrigin, BannerOriginWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, CommonQueryWithEntityContext, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, 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, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest, GetPostResponse, GetPostTemplatesSort, GetPostTemplatesSortWithLiterals, GetPostsSort, GetPostsSortWithLiterals, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListStyle, ListStyleWithLiterals, 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, 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, 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, SeoSchema, Settings, ShapeData, ShapeDataStyles, 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, 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.js';
2
+ import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, GetPostMetricsResponse, PostLikedEnvelope, PostUnlikedEnvelope, PostCreatedEnvelope, PostDeletedEnvelope, PostUpdatedEnvelope, PostQuery, QueryPostsOptions, typedQueryPosts, PostsQueryBuilder } from './index.typings.js';
3
+ export { AccountInfo, AccountInfoMetadata, ActionEvent, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerOrigin, BannerOriginWithLiterals, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BorderWidths, BulkDeletePostsRequest, BulkDeletePostsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, CommonQueryWithEntityContext, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CropWithLiterals, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DeletePostRequest, DeletePostResponse, Design, DesignTarget, DesignTargetWithLiterals, 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, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GetPostBySlugRequest, GetPostCountPerMonthRequest, GetPostCountPerMonthResponse, GetPostCountsRequest, GetPostCountsResponse, GetPostMetricsRequest, GetPostRequest, GetPostTemplatesSort, GetPostTemplatesSortWithLiterals, GetPostsSort, GetPostsSortWithLiterals, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LikePostRequest, LikePostResponse, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListStyle, ListStyleWithLiterals, 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, 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, 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, SeoSchema, Settings, ShapeData, ShapeDataStyles, 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, 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.js';
4
4
 
5
5
  declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
6
6
  interface QueryPostCountStatsSignature {
7
7
  /**
8
8
  * Retrieves the number of published posts per month within a specified time range.
9
9
  *
10
- * The time range is set using the `rangeStart` and `months` properties.
11
- * The time range always starts on the 1st day of the month set in `rangeStart` and
12
- * includes the number of `months` following `rangeStart`.
13
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
14
- * the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
15
- * > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
10
+ *
11
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
12
+ *
13
+ * You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
14
+ *
15
+ * >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
16
+ * @param - Options specifying time frame, sort, and filter.
16
17
  * @returns Get Blog Post Count Stats response
17
18
  */
18
19
  (options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 4>>;
@@ -21,6 +22,7 @@ declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature
21
22
  interface GetTotalPostsSignature {
22
23
  /**
23
24
  * Retrieves the total amount of published posts of the blog.
25
+ * @param - Language Options.
24
26
  */
25
27
  (options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 2>>;
26
28
  }
@@ -29,9 +31,9 @@ interface GetPostSignature {
29
31
  /**
30
32
  * Retrieves a post by the specified ID.
31
33
  * @param - Post ID.
32
- * @returns Retrieved post info.
34
+ * @param - Options specifying which fields to return.
33
35
  */
34
- (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
36
+ (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
35
37
  }
36
38
  declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
37
39
  interface GetPostBySlugSignature {
@@ -43,6 +45,7 @@ interface GetPostBySlugSignature {
43
45
  * the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
44
46
  * unless specified otherwise.
45
47
  * @param - Slug of the post to retrieve.
48
+ * @param - Options specifying which fields to return.
46
49
  */
47
50
  (slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
48
51
  }
@@ -55,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`, 6>>;
60
64
  }
@@ -102,4 +106,4 @@ declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1> & type
102
106
  */
103
107
  declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1> & typeof onPostUpdated$1;
104
108
 
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 };
109
+ export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostQuery, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
@@ -1424,26 +1424,6 @@ var ModerationStatusStatus = /* @__PURE__ */ ((ModerationStatusStatus2) => {
1424
1424
  ModerationStatusStatus2["REJECTED"] = "REJECTED";
1425
1425
  return ModerationStatusStatus2;
1426
1426
  })(ModerationStatusStatus || {});
1427
- var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
1428
- WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
1429
- WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
1430
- WebhookIdentityType2["MEMBER"] = "MEMBER";
1431
- WebhookIdentityType2["WIX_USER"] = "WIX_USER";
1432
- WebhookIdentityType2["APP"] = "APP";
1433
- return WebhookIdentityType2;
1434
- })(WebhookIdentityType || {});
1435
- var QueryPublicationsCountStatsRequestOrder = /* @__PURE__ */ ((QueryPublicationsCountStatsRequestOrder2) => {
1436
- QueryPublicationsCountStatsRequestOrder2["UNKNOWN"] = "UNKNOWN";
1437
- QueryPublicationsCountStatsRequestOrder2["OLDEST"] = "OLDEST";
1438
- QueryPublicationsCountStatsRequestOrder2["NEWEST"] = "NEWEST";
1439
- return QueryPublicationsCountStatsRequestOrder2;
1440
- })(QueryPublicationsCountStatsRequestOrder || {});
1441
- var Order = /* @__PURE__ */ ((Order2) => {
1442
- Order2["UNKNOWN"] = "UNKNOWN";
1443
- Order2["OLDEST"] = "OLDEST";
1444
- Order2["NEWEST"] = "NEWEST";
1445
- return Order2;
1446
- })(Order || {});
1447
1427
  var GetPostTemplatesSort = /* @__PURE__ */ ((GetPostTemplatesSort2) => {
1448
1428
  GetPostTemplatesSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1449
1429
  GetPostTemplatesSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
@@ -1497,16 +1477,34 @@ var Status = /* @__PURE__ */ ((Status2) => {
1497
1477
  Status2["IN_REVIEW"] = "IN_REVIEW";
1498
1478
  return Status2;
1499
1479
  })(Status || {});
1500
- var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1501
- GetPostsSort2["FEED"] = "FEED";
1502
- GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1503
- GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1504
- GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1505
- GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1506
- GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1507
- GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1508
- return GetPostsSort2;
1509
- })(GetPostsSort || {});
1480
+ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
1481
+ WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
1482
+ WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
1483
+ WebhookIdentityType2["MEMBER"] = "MEMBER";
1484
+ WebhookIdentityType2["WIX_USER"] = "WIX_USER";
1485
+ WebhookIdentityType2["APP"] = "APP";
1486
+ return WebhookIdentityType2;
1487
+ })(WebhookIdentityType || {});
1488
+ var QueryPublicationsCountStatsRequestOrder = /* @__PURE__ */ ((QueryPublicationsCountStatsRequestOrder2) => {
1489
+ QueryPublicationsCountStatsRequestOrder2["UNKNOWN"] = "UNKNOWN";
1490
+ QueryPublicationsCountStatsRequestOrder2["OLDEST"] = "OLDEST";
1491
+ QueryPublicationsCountStatsRequestOrder2["NEWEST"] = "NEWEST";
1492
+ return QueryPublicationsCountStatsRequestOrder2;
1493
+ })(QueryPublicationsCountStatsRequestOrder || {});
1494
+ var Order = /* @__PURE__ */ ((Order2) => {
1495
+ Order2["UNKNOWN"] = "UNKNOWN";
1496
+ Order2["OLDEST"] = "OLDEST";
1497
+ Order2["NEWEST"] = "NEWEST";
1498
+ return Order2;
1499
+ })(Order || {});
1500
+ var Field = /* @__PURE__ */ ((Field2) => {
1501
+ Field2["UNKNOWN"] = "UNKNOWN";
1502
+ Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1503
+ Field2["LIKE_COUNT"] = "LIKE_COUNT";
1504
+ Field2["VIEW_COUNT"] = "VIEW_COUNT";
1505
+ Field2["RATING_COUNT"] = "RATING_COUNT";
1506
+ return Field2;
1507
+ })(Field || {});
1510
1508
  var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1511
1509
  PostFieldField2["UNKNOWN"] = "UNKNOWN";
1512
1510
  PostFieldField2["URL"] = "URL";
@@ -1518,14 +1516,16 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1518
1516
  PostFieldField2["REFERENCE_ID"] = "REFERENCE_ID";
1519
1517
  return PostFieldField2;
1520
1518
  })(PostFieldField || {});
1521
- var Field = /* @__PURE__ */ ((Field2) => {
1522
- Field2["UNKNOWN"] = "UNKNOWN";
1523
- Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1524
- Field2["LIKE_COUNT"] = "LIKE_COUNT";
1525
- Field2["VIEW_COUNT"] = "VIEW_COUNT";
1526
- Field2["RATING_COUNT"] = "RATING_COUNT";
1527
- return Field2;
1528
- })(Field || {});
1519
+ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1520
+ GetPostsSort2["FEED"] = "FEED";
1521
+ GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1522
+ GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1523
+ GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1524
+ GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1525
+ GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1526
+ GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1527
+ return GetPostsSort2;
1528
+ })(GetPostsSort || {});
1529
1529
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
1530
1530
  SortOrder2["ASC"] = "ASC";
1531
1531
  SortOrder2["DESC"] = "DESC";
@@ -1624,8 +1624,8 @@ async function getPost2(postId, options) {
1624
1624
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1625
1625
  }
1626
1626
  ]),
1627
- ["post.richContent"]
1628
- )?.post;
1627
+ ["post.richContent", "post.rich_content"]
1628
+ );
1629
1629
  } catch (err) {
1630
1630
  const transformedError = (0, import_transform_error.transformError)(
1631
1631
  err,
@@ -1672,7 +1672,7 @@ async function getPostBySlug2(slug, options) {
1672
1672
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1673
1673
  }
1674
1674
  ]),
1675
- ["post.richContent"]
1675
+ ["post.richContent", "post.rich_content"]
1676
1676
  );
1677
1677
  } catch (err) {
1678
1678
  const transformedError = (0, import_transform_error.transformError)(
@@ -1731,7 +1731,7 @@ async function listPosts2(options) {
1731
1731
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1732
1732
  }
1733
1733
  ]),
1734
- ["posts.richContent"]
1734
+ ["posts.richContent", "posts.rich_content"]
1735
1735
  );
1736
1736
  } catch (err) {
1737
1737
  const transformedError = (0, import_transform_error.transformError)(
@@ -1801,7 +1801,7 @@ function queryPosts2(options) {
1801
1801
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1802
1802
  }
1803
1803
  ]),
1804
- ["posts.richContent"]
1804
+ ["posts.richContent", "posts.rich_content"]
1805
1805
  );
1806
1806
  return {
1807
1807
  items: transformedData?.posts,
@@ -1849,7 +1849,7 @@ async function typedQueryPosts(query, options) {
1849
1849
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1850
1850
  }
1851
1851
  ]),
1852
- ["posts.richContent"]
1852
+ ["posts.richContent", "posts.rich_content"]
1853
1853
  );
1854
1854
  } catch (err) {
1855
1855
  const transformedError = (0, import_transform_error.transformError)(
@@ -1963,7 +1963,8 @@ var onPostLiked = (0, import_sdk_types.EventDefinition)(
1963
1963
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1964
1964
  paths: [{ path: "metadata.eventTime" }]
1965
1965
  }
1966
- ])
1966
+ ]),
1967
+ ["entity.rich_content"]
1967
1968
  )
1968
1969
  )();
1969
1970
  var onPostUnliked = (0, import_sdk_types.EventDefinition)(
@@ -1975,7 +1976,8 @@ var onPostUnliked = (0, import_sdk_types.EventDefinition)(
1975
1976
  transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
1976
1977
  paths: [{ path: "metadata.eventTime" }]
1977
1978
  }
1978
- ])
1979
+ ]),
1980
+ ["entity.rich_content"]
1979
1981
  )
1980
1982
  )();
1981
1983
  var onPostCreated = (0, import_sdk_types.EventDefinition)(
@@ -2102,7 +2104,8 @@ var onPostCreated = (0, import_sdk_types.EventDefinition)(
2102
2104
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
2103
2105
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
2104
2106
  }
2105
- ])
2107
+ ]),
2108
+ ["entity.rich_content"]
2106
2109
  )
2107
2110
  )();
2108
2111
  var onPostDeleted = (0, import_sdk_types.EventDefinition)(
@@ -2229,7 +2232,8 @@ var onPostDeleted = (0, import_sdk_types.EventDefinition)(
2229
2232
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
2230
2233
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
2231
2234
  }
2232
- ])
2235
+ ]),
2236
+ ["entity.rich_content"]
2233
2237
  )
2234
2238
  )();
2235
2239
  var onPostUpdated = (0, import_sdk_types.EventDefinition)(
@@ -2356,7 +2360,8 @@ var onPostUpdated = (0, import_sdk_types.EventDefinition)(
2356
2360
  transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
2357
2361
  paths: [{ path: "entity.media.wixMedia.videoV2" }]
2358
2362
  }
2359
- ])
2363
+ ]),
2364
+ ["entity.rich_content"]
2360
2365
  )
2361
2366
  )();
2362
2367