@wix/auto_sdk_blog_posts 1.0.41 → 1.0.42
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.
- package/build/cjs/index.d.ts +7 -14
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +6 -20
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.d.mts +7 -14
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +6 -20
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +7 -14
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +6 -20
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/es/index.d.mts +7 -14
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +6 -20
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/package.json +3 -3
@@ -3615,7 +3615,6 @@ interface PostUpdatedEnvelope {
|
|
3615
3615
|
* @slug updated
|
3616
3616
|
*/
|
3617
3617
|
declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise<void>): void;
|
3618
|
-
type PostNonNullablePaths = `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`;
|
3619
3618
|
/**
|
3620
3619
|
* Retrieves the number of published posts per month within a specified time range.
|
3621
3620
|
*
|
@@ -3629,11 +3628,10 @@ type PostNonNullablePaths = `_id` | `title` | `excerpt` | `slug` | `featured` |
|
|
3629
3628
|
* @param options - Options specifying time frame, sort, and filter.
|
3630
3629
|
* @permissionId BLOG.READ-PUBLICATION
|
3631
3630
|
* @applicableIdentity APP
|
3632
|
-
* @applicableIdentity VISITOR
|
3633
3631
|
* @returns Get Blog Post Count Stats response
|
3634
3632
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
3635
3633
|
*/
|
3636
|
-
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount
|
3634
|
+
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`, 4>>;
|
3637
3635
|
interface QueryPostCountStatsOptions {
|
3638
3636
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
3639
3637
|
rangeStart?: Date | null;
|
@@ -3671,10 +3669,9 @@ interface QueryPostCountStatsOptions {
|
|
3671
3669
|
* @param options - Language Options.
|
3672
3670
|
* @permissionId BLOG.READ-PUBLICATION
|
3673
3671
|
* @applicableIdentity APP
|
3674
|
-
* @applicableIdentity VISITOR
|
3675
3672
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
3676
3673
|
*/
|
3677
|
-
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total
|
3674
|
+
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`, 2>>;
|
3678
3675
|
interface GetTotalPostsOptions {
|
3679
3676
|
/**
|
3680
3677
|
* Language filter.
|
@@ -3693,12 +3690,9 @@ interface GetTotalPostsOptions {
|
|
3693
3690
|
* @param options - Options specifying which fields to return.
|
3694
3691
|
* @permissionId BLOG.READ-PUBLICATION
|
3695
3692
|
* @applicableIdentity APP
|
3696
|
-
* @applicableIdentity VISITOR
|
3697
3693
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3698
3694
|
*/
|
3699
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, {
|
3700
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3701
|
-
}[PostNonNullablePaths]>>;
|
3695
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
|
3702
3696
|
interface GetPostOptions {
|
3703
3697
|
/**
|
3704
3698
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
@@ -3721,12 +3715,9 @@ interface GetPostOptions {
|
|
3721
3715
|
* @param options - Options specifying which fields to return.
|
3722
3716
|
* @permissionId BLOG.READ-PUBLICATION
|
3723
3717
|
* @applicableIdentity APP
|
3724
|
-
* @applicableIdentity VISITOR
|
3725
3718
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
3726
3719
|
*/
|
3727
|
-
declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
|
3728
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3729
|
-
}[PostNonNullablePaths]>>;
|
3720
|
+
declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
|
3730
3721
|
interface GetPostBySlugOptions {
|
3731
3722
|
/**
|
3732
3723
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
@@ -3747,12 +3738,9 @@ interface GetPostBySlugOptions {
|
|
3747
3738
|
* @param options - Sort, filter, and paging options.
|
3748
3739
|
* @permissionId BLOG.READ-PUBLICATION
|
3749
3740
|
* @applicableIdentity APP
|
3750
|
-
* @applicableIdentity VISITOR
|
3751
3741
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
3752
3742
|
*/
|
3753
|
-
declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
|
3754
|
-
[P in PostNonNullablePaths]: `posts.${number}.${P}`;
|
3755
|
-
}[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
3743
|
+
declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, `posts` | `posts.${number}._id` | `posts.${number}.title` | `posts.${number}.excerpt` | `posts.${number}.slug` | `posts.${number}.featured` | `posts.${number}.pinned` | `posts.${number}.coverMedia.enabled` | `posts.${number}.coverMedia.displayed` | `posts.${number}.coverMedia.custom` | `posts.${number}.memberId` | `posts.${number}.commentingEnabled` | `posts.${number}.minutesToRead` | `posts.${number}.seoData.settings.preventAutoRedirect` | `posts.${number}.preview` | `posts.${number}.moderationDetails.submittedBy` | `posts.${number}.moderationDetails.status` | `posts.${number}.media.displayed` | `posts.${number}.media.custom` | `posts.${number}.hasUnpublishedChanges` | `metaData.count` | `metaData.offset` | `metaData.total`, 6>>;
|
3756
3744
|
interface ListPostsOptions {
|
3757
3745
|
/**
|
3758
3746
|
* Whether to return only featured posts.
|
@@ -3840,7 +3828,6 @@ interface ListPostsOptions {
|
|
3840
3828
|
* @param options - Options specifying which fields to return.
|
3841
3829
|
* @permissionId BLOG.READ-PUBLICATION
|
3842
3830
|
* @applicableIdentity APP
|
3843
|
-
* @applicableIdentity VISITOR
|
3844
3831
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
3845
3832
|
*/
|
3846
3833
|
declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
|
@@ -3924,9 +3911,8 @@ interface PostsQueryBuilder {
|
|
3924
3911
|
* @requiredField postId
|
3925
3912
|
* @permissionId BLOG.READ-PUBLICATION
|
3926
3913
|
* @applicableIdentity APP
|
3927
|
-
* @applicableIdentity VISITOR
|
3928
3914
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
3929
3915
|
*/
|
3930
|
-
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views
|
3916
|
+
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
3931
3917
|
|
3932
3918
|
export { type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BulkGetPostMetricsRequest, type BulkGetPostMetricsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CoverMedia, type CoverMediaMediaOneOf, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type OldBlogMigratedEvent, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCountInfo, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type ScheduledPostPublished, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
|