@wix/auto_sdk_blog_posts 1.0.47 → 1.0.49
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 +29 -36
- package/build/cjs/index.js +10 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +22 -41
- package/build/cjs/index.typings.js +5 -5
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +29 -36
- package/build/es/index.mjs +10 -15
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +22 -41
- package/build/es/index.typings.mjs +5 -5
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +29 -36
- package/build/internal/cjs/index.js +10 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +22 -41
- package/build/internal/cjs/index.typings.js +5 -5
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +29 -36
- package/build/internal/es/index.mjs +10 -15
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +22 -41
- package/build/internal/es/index.typings.mjs +5 -5
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
@@ -3172,18 +3172,6 @@ interface GetPostMetricsResponse {
|
|
3172
3172
|
/** Retrieved post metrics. */
|
3173
3173
|
metrics?: Metrics;
|
3174
3174
|
}
|
3175
|
-
interface BulkGetPostMetricsRequest {
|
3176
|
-
/**
|
3177
|
-
* Post IDs.
|
3178
|
-
* @maxSize 500
|
3179
|
-
* @maxLength 38
|
3180
|
-
*/
|
3181
|
-
postIds?: string[];
|
3182
|
-
}
|
3183
|
-
interface BulkGetPostMetricsResponse {
|
3184
|
-
/** Map of post.id to metrics */
|
3185
|
-
metrics?: Record<string, Metrics>;
|
3186
|
-
}
|
3187
3175
|
interface ViewPostRequest {
|
3188
3176
|
/**
|
3189
3177
|
* Post ID.
|
@@ -3623,14 +3611,13 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
3623
3611
|
/**
|
3624
3612
|
* Retrieves the number of published posts per month within a specified time range.
|
3625
3613
|
*
|
3626
|
-
*
|
3627
|
-
* The
|
3628
|
-
*
|
3629
|
-
*
|
3630
|
-
*
|
3631
|
-
*
|
3614
|
+
* The time range is set using the `rangeStart` and `months` properties.
|
3615
|
+
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
3616
|
+
* includes the number of `months` following `rangeStart`.
|
3617
|
+
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
3618
|
+
* 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.
|
3619
|
+
* > 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.
|
3632
3620
|
* @public
|
3633
|
-
* @param options - Options specifying time frame, sort, and filter.
|
3634
3621
|
* @permissionId BLOG.READ-PUBLICATION
|
3635
3622
|
* @applicableIdentity APP
|
3636
3623
|
* @returns Get Blog Post Count Stats response
|
@@ -3671,7 +3658,6 @@ interface QueryPostCountStatsOptions {
|
|
3671
3658
|
/**
|
3672
3659
|
* Retrieves the total amount of published posts of the blog.
|
3673
3660
|
* @public
|
3674
|
-
* @param options - Language Options.
|
3675
3661
|
* @permissionId BLOG.READ-PUBLICATION
|
3676
3662
|
* @applicableIdentity APP
|
3677
3663
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
@@ -3692,12 +3678,12 @@ interface GetTotalPostsOptions {
|
|
3692
3678
|
* @param postId - Post ID.
|
3693
3679
|
* @public
|
3694
3680
|
* @requiredField postId
|
3695
|
-
* @param options - Options specifying which fields to return.
|
3696
3681
|
* @permissionId BLOG.READ-PUBLICATION
|
3697
3682
|
* @applicableIdentity APP
|
3683
|
+
* @returns Retrieved post info.
|
3698
3684
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3699
3685
|
*/
|
3700
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
3686
|
+
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
|
3701
3687
|
interface GetPostOptions {
|
3702
3688
|
/**
|
3703
3689
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
@@ -3717,7 +3703,6 @@ interface GetPostOptions {
|
|
3717
3703
|
* @param slug - Slug of the post to retrieve.
|
3718
3704
|
* @public
|
3719
3705
|
* @requiredField slug
|
3720
|
-
* @param options - Options specifying which fields to return.
|
3721
3706
|
* @permissionId BLOG.READ-PUBLICATION
|
3722
3707
|
* @applicableIdentity APP
|
3723
3708
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
@@ -3745,7 +3730,6 @@ interface GetPostBySlugOptions {
|
|
3745
3730
|
* - `paging.limit` is `50`.
|
3746
3731
|
* - `paging.offset` is `0`.
|
3747
3732
|
* @public
|
3748
|
-
* @param options - Sort, filter, and paging options.
|
3749
3733
|
* @permissionId BLOG.READ-PUBLICATION
|
3750
3734
|
* @applicableIdentity APP
|
3751
3735
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
@@ -3816,26 +3800,23 @@ interface ListPostsOptions {
|
|
3816
3800
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3817
3801
|
}
|
3818
3802
|
/**
|
3819
|
-
*
|
3820
|
-
*
|
3821
|
-
*
|
3822
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
3823
|
-
*
|
3824
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
3825
|
-
*
|
3826
|
-
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
3803
|
+
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
3827
3804
|
*
|
3828
|
-
*
|
3829
|
-
*
|
3830
|
-
*
|
3831
|
-
*
|
3832
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
3805
|
+
* Query Posts runs with these defaults, which you can override:
|
3806
|
+
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3807
|
+
* - `paging.limit` is `50`.
|
3808
|
+
* - `paging.offset` is `0`.
|
3833
3809
|
*
|
3834
|
-
*
|
3810
|
+
* For field support for filters and sorting, see
|
3811
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3835
3812
|
*
|
3836
|
-
*
|
3813
|
+
* To learn about working with _Query_ endpoints, see
|
3814
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
3815
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
3816
|
+
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
3817
|
+
* For a detailed list of supported filters and sortable fields, see
|
3818
|
+
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3837
3819
|
* @public
|
3838
|
-
* @param options - Options specifying which fields to return.
|
3839
3820
|
* @permissionId BLOG.READ-PUBLICATION
|
3840
3821
|
* @applicableIdentity APP
|
3841
3822
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
@@ -3925,4 +3906,4 @@ interface PostsQueryBuilder {
|
|
3925
3906
|
*/
|
3926
3907
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
3927
3908
|
|
3928
|
-
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
|
3909
|
+
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 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 };
|
@@ -1313,8 +1313,8 @@ async function getPost2(postId, options) {
|
|
1313
1313
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
1314
1314
|
}
|
1315
1315
|
]),
|
1316
|
-
["post.richContent"
|
1317
|
-
);
|
1316
|
+
["post.richContent"]
|
1317
|
+
)?.post;
|
1318
1318
|
} catch (err) {
|
1319
1319
|
const transformedError = sdkTransformError(
|
1320
1320
|
err,
|
@@ -1366,7 +1366,7 @@ async function getPostBySlug2(slug, options) {
|
|
1366
1366
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
1367
1367
|
}
|
1368
1368
|
]),
|
1369
|
-
["post.richContent"
|
1369
|
+
["post.richContent"]
|
1370
1370
|
);
|
1371
1371
|
} catch (err) {
|
1372
1372
|
const transformedError = sdkTransformError(
|
@@ -1430,7 +1430,7 @@ async function listPosts2(options) {
|
|
1430
1430
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
1431
1431
|
}
|
1432
1432
|
]),
|
1433
|
-
["posts.richContent"
|
1433
|
+
["posts.richContent"]
|
1434
1434
|
);
|
1435
1435
|
} catch (err) {
|
1436
1436
|
const transformedError = sdkTransformError(
|
@@ -1505,7 +1505,7 @@ function queryPosts2(options) {
|
|
1505
1505
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
1506
1506
|
}
|
1507
1507
|
]),
|
1508
|
-
["posts.richContent"
|
1508
|
+
["posts.richContent"]
|
1509
1509
|
);
|
1510
1510
|
return {
|
1511
1511
|
items: transformedData?.posts,
|