@wix/auto_sdk_blog_posts 1.0.33 → 1.0.35

package/build/cjs/index.d.ts

@@ -1,18 +1,19 @@
 import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { Q as QueryPostCountStatsOptions, a as QueryPostCountStatsResponse, G as GetTotalPostsOptions, b as GetTotalPostsResponse, c as GetPostOptions, P as Post, d as GetPostBySlugOptions, e as GetPostBySlugResponse, L as ListPostsOptions, f as ListPostsResponse, g as QueryPostsOptions, h as PostsQueryBuilder, i as GetPostMetricsResponse, j as PostCreatedEnvelope, k as PostDeletedEnvelope, l as PostLikedEnvelope, m as PostUnlikedEnvelope, n as PostUpdatedEnvelope } from './blog-v3-post-posts.universal-hTPKKRYx.js';
-export { c5 as ActionEvent, A as Alignment, bd as AnchorData, bj as AppEmbedData, bk as AppEmbedDataAppDataOneOf, H as AppType, by as AudioData, b3 as Background, b4 as BackgroundBackgroundOneOf, D as BackgroundType, d5 as BaseEventMetadata, bB as BlockquoteData, ca as BlogPaging, bl as BookingData, aj as Border, bw as BorderColors, cJ as BulkGetPostMetricsRequest, cK as BulkGetPostMetricsResponse, cX as BulkGetPostReactionsRequest, cY as BulkGetPostReactionsResponse, bA as BulletedListData, ai as ButtonData, bC as CaptionData, cd as Category, ce as CategoryTranslation, bv as CellStyle, au as CodeBlockData, br as CollapsibleListData, be as ColorData, ak as Colors, d0 as ConvertDraftJsToRichContentRequest, d1 as ConvertDraftJsToRichContentResponse, d2 as ConvertRichContentToDraftJsRequest, d3 as ConvertRichContentToDraftJsResponse, a5 as CoverMedia, a6 as CoverMediaMediaOneOf, ch as CreateDraftPostFromTemplateRequest, ci as CreateDraftPostFromTemplateResponse, C as Crop, cE as CursorPaging, cH as Cursors, bb as Decoration, bc as DecorationDataOneOf, E as DecorationType, b9 as Design, bt as Dimensions, J as Direction, aw as DividerData, bF as DocumentStyle, b$ as DomainEvent, c0 as DomainEventBodyOneOf, cj as DraftPost, ck as DraftPostTranslation, bp as EmbedData, bM as EmbedMedia, bN as EmbedThumbnail, bO as EmbedVideo, c1 as EntityCreatedEvent, c4 as EntityDeletedEvent, c3 as EntityUpdatedEvent, bm as EventData, d6 as EventMetadata, a1 as Field, ax as FileData, ay as FileSource, az as FileSourceDataOneOf, a7 as FocalPoint, bh as FontSizeData, F as FontType, aM as GIF, aL as GIFData, v as GIFType, aB as GalleryData, aH as GalleryOptions, cx as GetPostBySlugRequest, cI as GetPostMetricsRequest, cv as GetPostRequest, cw as GetPostResponse, _ as GetPostTemplatesSort, a3 as GetPostsSort, cf as GetTemplateRequest, cg as GetTemplateResponse, cl as GetTotalLikesPerMemberRequest, cm as GetTotalLikesPerMemberResponse, b_ as GetTotalPostsRequest, bY as GetTotalPublicationsRequest, bZ as GetTotalPublicationsResponse, b2 as Gradient, aO as HTMLData, aP as HTMLDataDataOneOf, aN as HeadingData, ap as Height, c7 as IdentificationData, c8 as IdentificationDataIdOneOf, aD as Image, aQ as ImageData, aS as ImageDataStyles, I as InitialExpandedItems, cu as InitialPostsCopied, aF as Item, aG as ItemDataOneOf, aJ as ItemStyle, ab as Keyword, aI as Layout, bD as LayoutCellData, t as LayoutType, cN as LikePostRequest, cO as LikePostResponse, r as LineStyle, ar as Link, bf as LinkData, as as LinkDataOneOf, aT as LinkPreviewData, aU as LinkPreviewDataStyles, c_ as ListDemoPostsRequest, c$ as ListDemoPostsResponse, cV as ListPostsArchiveRequest, cW as ListPostsArchiveResponse, cy as ListPostsRequest, c9 as ListTemplatesRequest, cb as ListTemplatesResponse, bx as ListValue, aV as MapData, aW as MapSettings, M as MapType, bI as Media, bJ as MediaMediaOneOf, bg as MentionData, c6 as MessageEnvelope, cc as MetaData, bE as Metadata, a9 as Metrics, bH as ModerationDetails, U as ModerationStatusStatus, af as Node, ag as NodeDataOneOf, ah as NodeStyle, N as NodeType, R as NullValue, bq as Oembed, d4 as OldBlogMigratedEvent, a_ as Option, b6 as OptionDesign, b1 as OptionLayout, Y as Order, bz as OrderedListData, O as Orientation, $ as Origin, aA as PDFSettings, cD as Paging, cG as PagingMetadataV2, aX as ParagraphData, bX as PeriodPostCount, bV as PeriodPublicationsCount, aZ as Permissions, cR as PinPostRequest, cS as PinPostResponse, cB as PlatformQuery, cC as PlatformQueryPagingMethodOneOf, bo as PlaybackOptions, al as PluginContainerData, o as PluginContainerDataAlignment, am as PluginContainerDataWidth, an as PluginContainerDataWidthDataOneOf, b7 as Poll, aY as PollData, b8 as PollDataLayout, b5 as PollDesign, b0 as PollLayout, B as PollLayoutDirection, z as PollLayoutType, a$ as PollSettings, w as Position, bQ as PostCategoriesUpdated, a8 as PostCountInfo, cr as PostCountersUpdated, cs as PostCountersUpdatedInitiatorOneOf, a2 as PostFieldField, cn as PostLiked, co as PostLikedInitiatorOneOf, ct as PostOwnerChanged, bR as PostTagsUpdated, bP as PostTranslation, cp as PostUnliked, cq as PostUnlikedInitiatorOneOf, d7 as PostsQueryResult, bW as QueryPostCountStatsRequest, cz as QueryPostsRequest, cF as QueryPostsResponse, bT as QueryPublicationsCountStatsRequest, X as QueryPublicationsCountStatsRequestOrder, bU as QueryPublicationsCountStatsResponse, cZ as Reactions, at as Rel, c2 as RestoreInfo, ae as RichContent, bS as ScheduledPostPublished, aa as SeoSchema, ad as Settings, a4 as SortOrder, cA as Sorting, S as Source, ao as Spoiler, bi as SpoilerData, a0 as Status, aq as Styles, aR as StylesBorder, bu as TableCellData, bs as TableData, ac as Tag, p as Target, q as TextAlignment, ba as TextData, bG as TextNodeStyle, av as TextStyle, aK as Thumbnails, u as ThumbnailsAlignment, T as Type, cP as UnlikePostRequest, cQ as UnlikePostResponse, cT as UnpinPostRequest, cU as UnpinPostResponse, aC as V1Media, K as VerticalAlignment, aE as Video, bn as VideoData, bL as VideoResolution, V as ViewMode, cL as ViewPostRequest, cM as ViewPostResponse, x as ViewRole, y as VoteRole, Z as WebhookIdentityType, s as Width, W as WidthType, bK as WixMedia } from './blog-v3-post-posts.universal-hTPKKRYx.js';
+import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, BulletedListData, ButtonData, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, ConvertDraftJsToRichContentRequest, ConvertDraftJsToRichContentResponse, ConvertRichContentToDraftJsRequest, ConvertRichContentToDraftJsResponse, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftPost, DraftPostTranslation, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetPostBySlugRequest, GetPostMetricsRequest, GetPostRequest, GetPostTemplatesSort, GetPostsSort, GetTemplateRequest, GetTemplateResponse, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, GetTotalPostsRequest, GetTotalPublicationsRequest, GetTotalPublicationsResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialPostsCopied, Item, ItemDataOneOf, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LikePostRequest, LikePostResponse, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDemoPostsRequest, ListDemoPostsResponse, ListPostsArchiveRequest, ListPostsArchiveResponse, ListPostsRequest, ListTemplatesRequest, ListTemplatesResponse, ListValue, MapData, MapSettings, MapType, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, Metrics, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, OldBlogMigratedEvent, Option, OptionDesign, OptionLayout, Order, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, PeriodPostCount, PeriodPublicationsCount, Permissions, PinPostRequest, PinPostResponse, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Post, PostCategoriesUpdated, PostCountInfo, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostFieldField, PostLiked, PostLikedInitiatorOneOf, PostOwnerChanged, PostTagsUpdated, PostTranslation, PostUnliked, PostUnlikedInitiatorOneOf, PostsQueryResult, QueryPostCountStatsRequest, QueryPostsRequest, QueryPostsResponse, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, QueryPublicationsCountStatsResponse, Reactions, Rel, RestoreInfo, RichContent, ScheduledPostPublished, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, UnlikePostRequest, UnlikePostResponse, UnpinPostRequest, UnpinPostResponse, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewPostRequest, ViewPostResponse, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia } from './index.typings.js';
 
 declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
 interface QueryPostCountStatsSignature {
     /**
      * Retrieves the number of published posts per month within a specified time range.
      *
-     * The time range is set 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 always ends on the last day of the month.
-     * > 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.
+     *
+     * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
+     *
+     * 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.
+     *
+     * >**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.
+     * @param - Options specifying time frame, sort, and filter.
      * @returns Get Blog Post Count Stats response
      */
     (options?: QueryPostCountStatsOptions | undefined): Promise<QueryPostCountStatsResponse>;
@@ -21,6 +22,7 @@ declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature
 interface GetTotalPostsSignature {
     /**
      * Retrieves the total amount of published posts of the blog.
+     * @param - Language Options.
      */
     (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse>;
 }
@@ -29,9 +31,9 @@ interface GetPostSignature {
     /**
      * Retrieves a post by the specified ID.
      * @param - Post ID.
-     * @returns Retrieved post info.
+     * @param - Options specifying which fields to return.
      */
-    (postId: string, options?: GetPostOptions | undefined): Promise<Post>;
+    (postId: string, options?: GetPostOptions | undefined): Promise<GetPostResponse>;
 }
 declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
 interface GetPostBySlugSignature {
@@ -43,6 +45,7 @@ interface GetPostBySlugSignature {
      * the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
      * unless specified otherwise.
      * @param - Slug of the post to retrieve.
+     * @param - Options specifying which fields to return.
      */
     (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse>;
 }
@@ -55,28 +58,32 @@ interface ListPostsSignature {
      * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
      * - `paging.limit` is `50`.
      * - `paging.offset` is `0`.
+     * @param - Sort, filter, and paging options.
      */
     (options?: ListPostsOptions | undefined): Promise<ListPostsResponse>;
 }
 declare function queryPosts$1(httpClient: HttpClient): QueryPostsSignature;
 interface QueryPostsSignature {
     /**
-     * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
+     * Creates a query to retrieve a list of posts.
      *
-     * Query Posts runs with these defaults, which you can override:
-     * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
-     * - `paging.limit` is `50`.
-     * - `paging.offset` is `0`.
      *
-     * For field support for filters and sorting, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
+     *
+     * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+     *
+     * 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.
+     *
+     * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
+     * + `limit(50)`
+     * + `descending('firstPublishedDate')`
+     *
+     * Note that the default limit is `'50'`, but the max limit is `'100'`.
+     *
+     * To learn how to query posts, refer to the table below.
      *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
-     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
-     * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
-     * For a detailed list of supported filters and sortable fields, see
-     * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
+     * 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`.
+     * @param - Options specifying which fields to return.
      */
     (options?: QueryPostsOptions | undefined): PostsQueryBuilder;
 }
@@ -124,4 +131,4 @@ declare const onPostUnliked: BuildEventDefinition<typeof onPostUnliked$1>;
  */
 declare const onPostUpdated: BuildEventDefinition<typeof onPostUpdated$1>;
 
-export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, Post, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };
+export { GetPostBySlugOptions, GetPostBySlugResponse, GetPostMetricsResponse, GetPostOptions, GetPostResponse, GetTotalPostsOptions, GetTotalPostsResponse, ListPostsOptions, ListPostsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope, PostsQueryBuilder, QueryPostCountStatsOptions, QueryPostCountStatsResponse, QueryPostsOptions, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts };

package/build/cjs/index.js

@@ -1363,8 +1363,8 @@ async function getPost2(postId, options) {
           paths: [{ path: "post.media.wixMedia.videoV2" }]
         }
       ]),
-      ["post.richContent"]
-    )?.post;
+      ["post.richContent", "post.rich_content"]
+    );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
       err,
@@ -1416,7 +1416,7 @@ async function getPostBySlug2(slug, options) {
           paths: [{ path: "post.media.wixMedia.videoV2" }]
         }
       ]),
-      ["post.richContent"]
+      ["post.richContent", "post.rich_content"]
     );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
@@ -1476,7 +1476,7 @@ async function listPosts2(options) {
           paths: [{ path: "posts.media.wixMedia.videoV2" }]
         }
       ]),
-      ["posts.richContent"]
+      ["posts.richContent", "posts.rich_content"]
     );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
@@ -1551,7 +1551,7 @@ function queryPosts2(options) {
             paths: [{ path: "posts.media.wixMedia.videoV2" }]
           }
         ]),
-        ["posts.richContent"]
+        ["posts.richContent", "posts.rich_content"]
       );
       return {
         items: transformedData?.posts,
@@ -1718,7 +1718,8 @@ var onPostCreated = (0, import_sdk_types.EventDefinition)(
         transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
         paths: [{ path: "entity.media.wixMedia.videoV2" }]
       }
-    ])
+    ]),
+    ["entity.rich_content"]
   )
 )();
 var onPostDeleted = (0, import_sdk_types.EventDefinition)(
@@ -1793,7 +1794,8 @@ var onPostDeleted = (0, import_sdk_types.EventDefinition)(
         transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
         paths: [{ path: "entity.media.wixMedia.videoV2" }]
       }
-    ])
+    ]),
+    ["entity.rich_content"]
   )
 )();
 var onPostLiked = (0, import_sdk_types.EventDefinition)(
@@ -1805,7 +1807,8 @@ var onPostLiked = (0, import_sdk_types.EventDefinition)(
         transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
         paths: [{ path: "metadata.eventTime" }]
       }
-    ])
+    ]),
+    ["entity.rich_content"]
   )
 )();
 var onPostUnliked = (0, import_sdk_types.EventDefinition)(
@@ -1817,7 +1820,8 @@ var onPostUnliked = (0, import_sdk_types.EventDefinition)(
         transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
         paths: [{ path: "metadata.eventTime" }]
       }
-    ])
+    ]),
+    ["entity.rich_content"]
   )
 )();
 var onPostUpdated = (0, import_sdk_types.EventDefinition)(
@@ -1892,7 +1896,8 @@ var onPostUpdated = (0, import_sdk_types.EventDefinition)(
         transformFn: import_video_v22.transformRESTVideoV2ToSDKVideoV2,
         paths: [{ path: "entity.media.wixMedia.videoV2" }]
       }
-    ])
+    ]),
+    ["entity.rich_content"]
   )
 )();