@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
|
@@ -2504,19 +2504,19 @@ declare enum WebhookIdentityType {
|
|
|
2504
2504
|
}
|
|
2505
2505
|
/** @enumType */
|
|
2506
2506
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2507
|
-
interface
|
|
2507
|
+
interface AccountInfo {
|
|
2508
2508
|
/**
|
|
2509
|
-
* ID of the account.
|
|
2509
|
+
* ID of the Wix account associated with the event.
|
|
2510
2510
|
* @format GUID
|
|
2511
2511
|
*/
|
|
2512
2512
|
accountId?: string | null;
|
|
2513
2513
|
/**
|
|
2514
|
-
* ID of the parent account.
|
|
2514
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2515
2515
|
* @format GUID
|
|
2516
2516
|
*/
|
|
2517
2517
|
parentAccountId?: string | null;
|
|
2518
2518
|
/**
|
|
2519
|
-
* ID of the site
|
|
2519
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2520
2520
|
* @format GUID
|
|
2521
2521
|
*/
|
|
2522
2522
|
siteId?: string | null;
|
|
@@ -3759,13 +3759,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
3759
3759
|
/**
|
|
3760
3760
|
* Retrieves the number of published posts per month within a specified time range.
|
|
3761
3761
|
*
|
|
3762
|
-
*
|
|
3763
|
-
* The
|
|
3764
|
-
*
|
|
3765
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
3766
|
-
*
|
|
3767
|
-
*
|
|
3762
|
+
*
|
|
3763
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
3764
|
+
*
|
|
3765
|
+
* 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.
|
|
3766
|
+
*
|
|
3767
|
+
* >**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.
|
|
3768
3768
|
* @public
|
|
3769
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
3769
3770
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3770
3771
|
* @applicableIdentity APP
|
|
3771
3772
|
* @returns Get Blog Post Count Stats response
|
|
@@ -3806,6 +3807,7 @@ interface QueryPostCountStatsOptions {
|
|
|
3806
3807
|
/**
|
|
3807
3808
|
* Retrieves the total amount of published posts of the blog.
|
|
3808
3809
|
* @public
|
|
3810
|
+
* @param options - Language Options.
|
|
3809
3811
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3810
3812
|
* @applicableIdentity APP
|
|
3811
3813
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -3826,12 +3828,12 @@ interface GetTotalPostsOptions {
|
|
|
3826
3828
|
* @param postId - Post ID.
|
|
3827
3829
|
* @public
|
|
3828
3830
|
* @requiredField postId
|
|
3831
|
+
* @param options - Options specifying which fields to return.
|
|
3829
3832
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3830
3833
|
* @applicableIdentity APP
|
|
3831
|
-
* @returns Retrieved post info.
|
|
3832
3834
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
3833
3835
|
*/
|
|
3834
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
3836
|
+
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>>;
|
|
3835
3837
|
interface GetPostOptions {
|
|
3836
3838
|
/**
|
|
3837
3839
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -3851,6 +3853,7 @@ interface GetPostOptions {
|
|
|
3851
3853
|
* @param slug - Slug of the post to retrieve.
|
|
3852
3854
|
* @public
|
|
3853
3855
|
* @requiredField slug
|
|
3856
|
+
* @param options - Options specifying which fields to return.
|
|
3854
3857
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3855
3858
|
* @applicableIdentity APP
|
|
3856
3859
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -3878,6 +3881,7 @@ interface GetPostBySlugOptions {
|
|
|
3878
3881
|
* - `paging.limit` is `50`.
|
|
3879
3882
|
* - `paging.offset` is `0`.
|
|
3880
3883
|
* @public
|
|
3884
|
+
* @param options - Sort, filter, and paging options.
|
|
3881
3885
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3882
3886
|
* @applicableIdentity APP
|
|
3883
3887
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -3948,23 +3952,26 @@ interface ListPostsOptions {
|
|
|
3948
3952
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
3949
3953
|
}
|
|
3950
3954
|
/**
|
|
3951
|
-
*
|
|
3955
|
+
* Creates a query to retrieve a list of posts.
|
|
3952
3956
|
*
|
|
3953
|
-
* Query Posts runs with these defaults, which you can override:
|
|
3954
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
3955
|
-
* - `paging.limit` is `50`.
|
|
3956
|
-
* - `paging.offset` is `0`.
|
|
3957
3957
|
*
|
|
3958
|
-
*
|
|
3959
|
-
*
|
|
3958
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
3959
|
+
*
|
|
3960
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
3961
|
+
*
|
|
3962
|
+
* 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.
|
|
3963
|
+
*
|
|
3964
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
3965
|
+
* + `limit(50)`
|
|
3966
|
+
* + `descending('firstPublishedDate')`
|
|
3967
|
+
*
|
|
3968
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
3969
|
+
*
|
|
3970
|
+
* To learn how to query posts, refer to the table below.
|
|
3960
3971
|
*
|
|
3961
|
-
*
|
|
3962
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
3963
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
|
3964
|
-
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
3965
|
-
* For a detailed list of supported filters and sortable fields, see
|
|
3966
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
|
3972
|
+
* 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`.
|
|
3967
3973
|
* @public
|
|
3974
|
+
* @param options - Options specifying which fields to return.
|
|
3968
3975
|
* @permissionId BLOG.READ-PUBLICATION
|
|
3969
3976
|
* @applicableIdentity APP
|
|
3970
3977
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -4111,4 +4118,4 @@ type PostQuery = {
|
|
|
4111
4118
|
*/
|
|
4112
4119
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
|
|
4113
4120
|
|
|
4114
|
-
export { type
|
|
4121
|
+
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 };
|
|
@@ -1323,8 +1323,8 @@ async function getPost2(postId, options) {
|
|
|
1323
1323
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1324
1324
|
}
|
|
1325
1325
|
]),
|
|
1326
|
-
["post.richContent"]
|
|
1327
|
-
)
|
|
1326
|
+
["post.richContent", "post.rich_content"]
|
|
1327
|
+
);
|
|
1328
1328
|
} catch (err) {
|
|
1329
1329
|
const transformedError = (0, import_transform_error.transformError)(
|
|
1330
1330
|
err,
|
|
@@ -1376,7 +1376,7 @@ async function getPostBySlug2(slug, options) {
|
|
|
1376
1376
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1377
1377
|
}
|
|
1378
1378
|
]),
|
|
1379
|
-
["post.richContent"]
|
|
1379
|
+
["post.richContent", "post.rich_content"]
|
|
1380
1380
|
);
|
|
1381
1381
|
} catch (err) {
|
|
1382
1382
|
const transformedError = (0, import_transform_error.transformError)(
|
|
@@ -1440,7 +1440,7 @@ async function listPosts2(options) {
|
|
|
1440
1440
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1441
1441
|
}
|
|
1442
1442
|
]),
|
|
1443
|
-
["posts.richContent"]
|
|
1443
|
+
["posts.richContent", "posts.rich_content"]
|
|
1444
1444
|
);
|
|
1445
1445
|
} catch (err) {
|
|
1446
1446
|
const transformedError = (0, import_transform_error.transformError)(
|
|
@@ -1515,7 +1515,7 @@ function queryPosts2(options) {
|
|
|
1515
1515
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1516
1516
|
}
|
|
1517
1517
|
]),
|
|
1518
|
-
["posts.richContent"]
|
|
1518
|
+
["posts.richContent", "posts.rich_content"]
|
|
1519
1519
|
);
|
|
1520
1520
|
return {
|
|
1521
1521
|
items: transformedData?.posts,
|
|
@@ -1568,7 +1568,7 @@ async function typedQueryPosts(query, options) {
|
|
|
1568
1568
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1569
1569
|
}
|
|
1570
1570
|
]),
|
|
1571
|
-
["posts.richContent"]
|
|
1571
|
+
["posts.richContent", "posts.rich_content"]
|
|
1572
1572
|
);
|
|
1573
1573
|
} catch (err) {
|
|
1574
1574
|
const transformedError = (0, import_transform_error.transformError)(
|