@wix/auto_sdk_blog_posts 1.0.185 → 1.0.187
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 +26 -11
- package/build/cjs/index.js +72 -13
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +43 -19
- package/build/cjs/index.typings.js +54 -8
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +6 -3
- package/build/cjs/meta.js +43 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +26 -11
- package/build/es/index.mjs +70 -12
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +43 -19
- package/build/es/index.typings.mjs +52 -7
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +6 -3
- package/build/es/meta.mjs +41 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +26 -11
- package/build/internal/cjs/index.typings.d.ts +43 -19
- package/build/internal/cjs/meta.d.ts +6 -3
- package/build/internal/es/index.d.mts +26 -11
- package/build/internal/es/index.typings.d.mts +43 -19
- package/build/internal/es/meta.d.mts +6 -3
- package/package.json +2 -2
|
@@ -4019,7 +4019,7 @@ interface ViewPostRequest {
|
|
|
4019
4019
|
* @minLength 1
|
|
4020
4020
|
* @maxLength 38
|
|
4021
4021
|
*/
|
|
4022
|
-
postId
|
|
4022
|
+
postId: string;
|
|
4023
4023
|
}
|
|
4024
4024
|
interface ViewPostResponse {
|
|
4025
4025
|
/** Total number of post views */
|
|
@@ -4384,13 +4384,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
|
|
|
4384
4384
|
/**
|
|
4385
4385
|
* Retrieves the number of published posts per month within a specified time range.
|
|
4386
4386
|
*
|
|
4387
|
-
*
|
|
4388
|
-
* The
|
|
4389
|
-
*
|
|
4390
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
|
4391
|
-
*
|
|
4392
|
-
*
|
|
4387
|
+
*
|
|
4388
|
+
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
|
4389
|
+
*
|
|
4390
|
+
* 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.
|
|
4391
|
+
*
|
|
4392
|
+
* >**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.
|
|
4393
4393
|
* @public
|
|
4394
|
+
* @param options - Options specifying time frame, sort, and filter.
|
|
4394
4395
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4395
4396
|
* @applicableIdentity APP
|
|
4396
4397
|
* @returns Get Blog Post Count Stats response
|
|
@@ -4431,6 +4432,7 @@ interface QueryPostCountStatsOptions {
|
|
|
4431
4432
|
/**
|
|
4432
4433
|
* Retrieves the total amount of published posts of the blog.
|
|
4433
4434
|
* @public
|
|
4435
|
+
* @param options - Language Options.
|
|
4434
4436
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4435
4437
|
* @applicableIdentity APP
|
|
4436
4438
|
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
|
@@ -4451,12 +4453,12 @@ interface GetTotalPostsOptions {
|
|
|
4451
4453
|
* @param postId - Post ID.
|
|
4452
4454
|
* @public
|
|
4453
4455
|
* @requiredField postId
|
|
4456
|
+
* @param options - Options specifying which fields to return.
|
|
4454
4457
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4455
4458
|
* @applicableIdentity APP
|
|
4456
|
-
* @returns Retrieved post info.
|
|
4457
4459
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
|
4458
4460
|
*/
|
|
4459
|
-
declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<
|
|
4461
|
+
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.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`, 5>>;
|
|
4460
4462
|
interface GetPostOptions {
|
|
4461
4463
|
/**
|
|
4462
4464
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4476,6 +4478,7 @@ interface GetPostOptions {
|
|
|
4476
4478
|
* @param slug - Slug of the post to retrieve.
|
|
4477
4479
|
* @public
|
|
4478
4480
|
* @requiredField slug
|
|
4481
|
+
* @param options - Options specifying which fields to return.
|
|
4479
4482
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4480
4483
|
* @applicableIdentity APP
|
|
4481
4484
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
|
@@ -4503,6 +4506,7 @@ interface GetPostBySlugOptions {
|
|
|
4503
4506
|
* - `paging.limit` is `50`.
|
|
4504
4507
|
* - `paging.offset` is `0`.
|
|
4505
4508
|
* @public
|
|
4509
|
+
* @param options - Sort, filter, and paging options.
|
|
4506
4510
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4507
4511
|
* @applicableIdentity APP
|
|
4508
4512
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
|
@@ -4573,18 +4577,26 @@ interface ListPostsOptions {
|
|
|
4573
4577
|
fieldsets?: PostFieldFieldWithLiterals[];
|
|
4574
4578
|
}
|
|
4575
4579
|
/**
|
|
4576
|
-
*
|
|
4580
|
+
* Creates a query to retrieve a list of posts.
|
|
4577
4581
|
*
|
|
4578
|
-
* Query Posts runs with these defaults, which you can override:
|
|
4579
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
|
4580
|
-
* - `paging.limit` is `50`.
|
|
4581
|
-
* - `paging.offset` is `0`.
|
|
4582
4582
|
*
|
|
4583
|
-
*
|
|
4584
|
-
*
|
|
4585
|
-
*
|
|
4586
|
-
*
|
|
4583
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
|
4584
|
+
*
|
|
4585
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
4586
|
+
*
|
|
4587
|
+
* 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.
|
|
4588
|
+
*
|
|
4589
|
+
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
|
4590
|
+
* + `limit(50)`
|
|
4591
|
+
* + `descending('firstPublishedDate')`
|
|
4592
|
+
*
|
|
4593
|
+
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
4594
|
+
*
|
|
4595
|
+
* To learn how to query posts, refer to the table below.
|
|
4596
|
+
*
|
|
4597
|
+
* 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`.
|
|
4587
4598
|
* @public
|
|
4599
|
+
* @param options - Options specifying which fields to return.
|
|
4588
4600
|
* @permissionId BLOG.READ-PUBLICATION
|
|
4589
4601
|
* @applicableIdentity APP
|
|
4590
4602
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
|
@@ -4852,5 +4864,17 @@ declare const utils: {
|
|
|
4852
4864
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
|
4853
4865
|
*/
|
|
4854
4866
|
declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 1>>;
|
|
4867
|
+
/**
|
|
4868
|
+
* Increments a post's view count.
|
|
4869
|
+
*
|
|
4870
|
+
* Call this method when a site visitor views a published post. The response returns the post's updated total number of views.
|
|
4871
|
+
* @param postId - Post ID.
|
|
4872
|
+
* @public
|
|
4873
|
+
* @requiredField postId
|
|
4874
|
+
* @permissionId BLOG.READ-PUBLICATION
|
|
4875
|
+
* @applicableIdentity APP
|
|
4876
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ViewPost
|
|
4877
|
+
*/
|
|
4878
|
+
declare function viewPost(postId: string): Promise<NonNullablePaths<ViewPostResponse, `views`, 0>>;
|
|
4855
4879
|
|
|
4856
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, 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 GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, 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 PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, 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 SectionDivider, type SeoSchema, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, 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 TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, 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, utils };
|
|
4880
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, 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 GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, 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 PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, 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 SectionDivider, type SeoSchema, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, 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 TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, 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, utils, viewPost };
|
|
@@ -1086,6 +1086,27 @@ function getPostMetrics(payload) {
|
|
|
1086
1086
|
}
|
|
1087
1087
|
return __getPostMetrics;
|
|
1088
1088
|
}
|
|
1089
|
+
function viewPost(payload) {
|
|
1090
|
+
function __viewPost({ host }) {
|
|
1091
|
+
const metadata = {
|
|
1092
|
+
entityFqdn: "wix.blog.v3.post",
|
|
1093
|
+
method: "POST",
|
|
1094
|
+
methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.ViewPost",
|
|
1095
|
+
packageName: PACKAGE_NAME,
|
|
1096
|
+
migrationOptions: {
|
|
1097
|
+
optInTransformResponse: true
|
|
1098
|
+
},
|
|
1099
|
+
url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
|
|
1100
|
+
protoPath: "/v3/posts/{postId}/view",
|
|
1101
|
+
data: payload,
|
|
1102
|
+
host
|
|
1103
|
+
}),
|
|
1104
|
+
data: payload
|
|
1105
|
+
};
|
|
1106
|
+
return metadata;
|
|
1107
|
+
}
|
|
1108
|
+
return __viewPost;
|
|
1109
|
+
}
|
|
1089
1110
|
|
|
1090
1111
|
// src/blog-v3-post-posts.universal.ts
|
|
1091
1112
|
import { transformRESTImageToSDKImage } from "@wix/sdk-runtime/transformations/image";
|
|
@@ -1766,8 +1787,8 @@ async function getPost2(postId, options) {
|
|
|
1766
1787
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1767
1788
|
}
|
|
1768
1789
|
]),
|
|
1769
|
-
["post.richContent"]
|
|
1770
|
-
)
|
|
1790
|
+
["post.richContent", "post.rich_content"]
|
|
1791
|
+
);
|
|
1771
1792
|
} catch (err) {
|
|
1772
1793
|
const transformedError = sdkTransformError(
|
|
1773
1794
|
err,
|
|
@@ -1814,7 +1835,7 @@ async function getPostBySlug2(slug, options) {
|
|
|
1814
1835
|
paths: [{ path: "post.media.wixMedia.videoV2" }]
|
|
1815
1836
|
}
|
|
1816
1837
|
]),
|
|
1817
|
-
["post.richContent"]
|
|
1838
|
+
["post.richContent", "post.rich_content"]
|
|
1818
1839
|
);
|
|
1819
1840
|
} catch (err) {
|
|
1820
1841
|
const transformedError = sdkTransformError(
|
|
@@ -1873,7 +1894,7 @@ async function listPosts2(options) {
|
|
|
1873
1894
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1874
1895
|
}
|
|
1875
1896
|
]),
|
|
1876
|
-
["posts.richContent"]
|
|
1897
|
+
["posts.richContent", "posts.rich_content"]
|
|
1877
1898
|
);
|
|
1878
1899
|
} catch (err) {
|
|
1879
1900
|
const transformedError = sdkTransformError(
|
|
@@ -1943,7 +1964,7 @@ function queryPosts2(options) {
|
|
|
1943
1964
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1944
1965
|
}
|
|
1945
1966
|
]),
|
|
1946
|
-
["posts.richContent"]
|
|
1967
|
+
["posts.richContent", "posts.rich_content"]
|
|
1947
1968
|
);
|
|
1948
1969
|
return {
|
|
1949
1970
|
items: transformedData?.posts,
|
|
@@ -1991,7 +2012,7 @@ async function typedQueryPosts(query, options) {
|
|
|
1991
2012
|
paths: [{ path: "posts.media.wixMedia.videoV2" }]
|
|
1992
2013
|
}
|
|
1993
2014
|
]),
|
|
1994
|
-
["posts.richContent"]
|
|
2015
|
+
["posts.richContent", "posts.rich_content"]
|
|
1995
2016
|
);
|
|
1996
2017
|
} catch (err) {
|
|
1997
2018
|
const transformedError = sdkTransformError(
|
|
@@ -2033,6 +2054,29 @@ async function getPostMetrics2(postId) {
|
|
|
2033
2054
|
throw transformedError;
|
|
2034
2055
|
}
|
|
2035
2056
|
}
|
|
2057
|
+
async function viewPost2(postId) {
|
|
2058
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
2059
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({ postId }, []);
|
|
2060
|
+
const reqOpts = viewPost(payload);
|
|
2061
|
+
sideEffects?.onSiteCall?.();
|
|
2062
|
+
try {
|
|
2063
|
+
const result = await httpClient.request(reqOpts);
|
|
2064
|
+
sideEffects?.onSuccess?.(result);
|
|
2065
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data, []);
|
|
2066
|
+
} catch (err) {
|
|
2067
|
+
const transformedError = sdkTransformError(
|
|
2068
|
+
err,
|
|
2069
|
+
{
|
|
2070
|
+
spreadPathsToArguments: {},
|
|
2071
|
+
explicitPathsToArguments: { postId: "$[0]" },
|
|
2072
|
+
singleArgumentUnchanged: false
|
|
2073
|
+
},
|
|
2074
|
+
["postId"]
|
|
2075
|
+
);
|
|
2076
|
+
sideEffects?.onError?.(err);
|
|
2077
|
+
throw transformedError;
|
|
2078
|
+
}
|
|
2079
|
+
}
|
|
2036
2080
|
export {
|
|
2037
2081
|
Alignment,
|
|
2038
2082
|
AppType,
|
|
@@ -2113,6 +2157,7 @@ export {
|
|
|
2113
2157
|
queryPostCountStats2 as queryPostCountStats,
|
|
2114
2158
|
queryPosts2 as queryPosts,
|
|
2115
2159
|
typedQueryPosts,
|
|
2116
|
-
utils
|
|
2160
|
+
utils,
|
|
2161
|
+
viewPost2 as viewPost
|
|
2117
2162
|
};
|
|
2118
2163
|
//# sourceMappingURL=index.typings.mjs.map
|