@wix/auto_sdk_blog_posts 1.0.107 → 1.0.108
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 +15 -11
- package/build/cjs/index.js +16 -11
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +33 -26
- package/build/cjs/index.typings.js +6 -6
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +5 -5
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +15 -11
- package/build/es/index.mjs +16 -11
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +33 -26
- package/build/es/index.typings.mjs +6 -6
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +5 -5
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +15 -11
- package/build/internal/cjs/index.js +16 -11
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +33 -26
- package/build/internal/cjs/index.typings.js +6 -6
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +5 -5
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +15 -11
- package/build/internal/es/index.mjs +16 -11
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +33 -26
- package/build/internal/es/index.typings.mjs +6 -6
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +5 -5
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2497,19 +2497,19 @@ declare enum WebhookIdentityType {
|
|
|
2497
2497
|
}
|
|
2498
2498
|
/** @enumType */
|
|
2499
2499
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2500
|
-
interface
|
|
2500
|
+
interface AccountInfo {
|
|
2501
2501
|
/**
|
|
2502
|
-
* ID of the account.
|
|
2502
|
+
* ID of the Wix account associated with the event.
|
|
2503
2503
|
* @format GUID
|
|
2504
2504
|
*/
|
|
2505
2505
|
accountId?: string | null;
|
|
2506
2506
|
/**
|
|
2507
|
-
* ID of the parent account.
|
|
2507
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2508
2508
|
* @format GUID
|
|
2509
2509
|
*/
|
|
2510
2510
|
parentAccountId?: string | null;
|
|
2511
2511
|
/**
|
|
2512
|
-
* ID of the site
|
|
2512
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2513
2513
|
* @format GUID
|
|
2514
2514
|
*/
|
|
2515
2515
|
siteId?: string | null;
|
|
@@ -3752,13 +3752,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3752
3752
|
/**
|
|
3753
3753
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3754
3754
|
*
|
|
3755
|
-
*
|
|
3756
|
-
* The
|
|
3757
|
-
*
|
|
3758
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3759
|
-
*
|
|
3760
|
-
*
|
|
3755
|
+
*
|
|
3756
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
3757
|
+
*
|
|
3758
|
+
* 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.
|
|
3759
|
+
*
|
|
3760
|
+
* >**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.
|
|
3761
3761
|
* @public
|
|
3762
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
3762
3763
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3763
3764
|
* @applicableIdentity APP
|
|
3764
3765
|
* @returns Get Blog Post Count Stats response
|
|
@@ -3799,6 +3800,7 @@ interface QueryPostCountStatsOptions {
|
|
|
3799
3800
|
/**
|
|
3800
3801
|
* Retrieves the total amount of published posts of the blog.
|
|
3801
3802
|
* @public
|
|
3803
|
+
* @param options - Language Options.
|
|
3802
3804
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3803
3805
|
* @applicableIdentity APP
|
|
3804
3806
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -3819,12 +3821,12 @@ interface GetTotalPostsOptions {
|
|
|
3819
3821
|
* @param postId - Post ID.
|
|
3820
3822
|
* @public
|
|
3821
3823
|
* @requiredField postId
|
|
3824
|
+
* @param options - Options specifying which fields to return.
|
|
3822
3825
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3823
3826
|
* @applicableIdentity APP
|
|
3824
|
-
* @returns Retrieved post info.
|
|
3825
3827
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3826
3828
|
*/
|
|
3827
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
3829
|
+
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>>;
|
|
3828
3830
|
interface GetPostOptions {
|
|
3829
3831
|
/**
|
|
3830
3832
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3844,6 +3846,7 @@ interface GetPostOptions {
|
|
|
3844
3846
|
* @param slug - Slug of the post to retrieve.
|
|
3845
3847
|
* @public
|
|
3846
3848
|
* @requiredField slug
|
|
3849
|
+
* @param options - Options specifying which fields to return.
|
|
3847
3850
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3848
3851
|
* @applicableIdentity APP
|
|
3849
3852
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -3871,6 +3874,7 @@ interface GetPostBySlugOptions {
|
|
|
3871
3874
|
* - `paging.limit` is `50`.
|
|
3872
3875
|
* - `paging.offset` is `0`.
|
|
3873
3876
|
* @public
|
|
3877
|
+
* @param options - Sort, filter, and paging options.
|
|
3874
3878
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3875
3879
|
* @applicableIdentity APP
|
|
3876
3880
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -3941,23 +3945,26 @@ interface ListPostsOptions {
|
|
|
3941
3945
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3942
3946
|
}
|
|
3943
3947
|
/**
|
|
3944
|
-
*
|
|
3948
|
+
* Creates a query to retrieve a list of posts.
|
|
3945
3949
|
*
|
|
3946
|
-
* Query Posts runs with these defaults, which you can override:
|
|
3947
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
3948
|
-
* - `paging.limit` is `50`.
|
|
3949
|
-
* - `paging.offset` is `0`.
|
|
3950
3950
|
*
|
|
3951
|
-
*
|
|
3952
|
-
*
|
|
3951
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
3952
|
+
*
|
|
3953
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
3954
|
+
*
|
|
3955
|
+
* 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.
|
|
3956
|
+
*
|
|
3957
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
3958
|
+
* + `limit(50)`
|
|
3959
|
+
* + `descending('firstPublishedDate')`
|
|
3960
|
+
*
|
|
3961
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
3962
|
+
*
|
|
3963
|
+
* To learn how to query posts, refer to the table below.
|
|
3953
3964
|
*
|
|
3954
|
-
*
|
|
3955
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
3956
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
|
3957
|
-
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
3958
|
-
* For a detailed list of supported filters and sortable fields, see
|
|
3959
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
|
3965
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
|
|
3960
3966
|
* @public
|
|
3967
|
+
* @param options - Options specifying which fields to return.
|
|
3961
3968
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3962
3969
|
* @applicableIdentity APP
|
|
3963
3970
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -4104,4 +4111,4 @@ type PostQuery = {
|
|
|
4104
4111
|
*/
|
|
4105
4112
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4106
4113
|
|
|
4107
|
-
export { type
|
|
4114
|
+
export { type AccountInfo, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, 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 CommonQueryWithEntityContext, 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, DesignTarget, type DesignTargetWithLiterals, 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 FontFamilyData, 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 GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, 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, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, 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 PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, 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, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, 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, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, 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, typedQueryPosts };
|
|
@@ -1240,8 +1240,8 @@ async function getPost2(postId, options) {
|
|
|
1240
1240
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1241
1241
|
}
|
|
1242
1242
|
]),
|
|
1243
|
-
["post.richContent"]
|
|
1244
|
-
)
|
|
1243
|
+
["post.richContent", "post.rich_content"]
|
|
1244
|
+
);
|
|
1245
1245
|
} catch (err) {
|
|
1246
1246
|
const transformedError = sdkTransformError(
|
|
1247
1247
|
err,
|
|
@@ -1293,7 +1293,7 @@ async function getPostBySlug2(slug, options) {
|
|
|
1293
1293
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1294
1294
|
}
|
|
1295
1295
|
]),
|
|
1296
|
-
["post.richContent"]
|
|
1296
|
+
["post.richContent", "post.rich_content"]
|
|
1297
1297
|
);
|
|
1298
1298
|
} catch (err) {
|
|
1299
1299
|
const transformedError = sdkTransformError(
|
|
@@ -1357,7 +1357,7 @@ async function listPosts2(options) {
|
|
|
1357
1357
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1358
1358
|
}
|
|
1359
1359
|
]),
|
|
1360
|
-
["posts.richContent"]
|
|
1360
|
+
["posts.richContent", "posts.rich_content"]
|
|
1361
1361
|
);
|
|
1362
1362
|
} catch (err) {
|
|
1363
1363
|
const transformedError = sdkTransformError(
|
|
@@ -1432,7 +1432,7 @@ function queryPosts2(options) {
|
|
|
1432
1432
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1433
1433
|
}
|
|
1434
1434
|
]),
|
|
1435
|
-
["posts.richContent"]
|
|
1435
|
+
["posts.richContent", "posts.rich_content"]
|
|
1436
1436
|
);
|
|
1437
1437
|
return {
|
|
1438
1438
|
items: transformedData?.posts,
|
|
@@ -1485,7 +1485,7 @@ async function typedQueryPosts(query, options) {
|
|
|
1485
1485
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1486
1486
|
}
|
|
1487
1487
|
]),
|
|
1488
|
-
["posts.richContent"]
|
|
1488
|
+
["posts.richContent", "posts.rich_content"]
|
|
1489
1489
|
);
|
|
1490
1490
|
} catch (err) {
|
|
1491
1491
|
const transformedError = sdkTransformError(
|