@wix/auto_sdk_blog_posts 1.0.34 → 1.0.36

package/build/es/index.d.mts

@@ -1,7 +1,8 @@
-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, d as GetPostResponse, e as GetPostBySlugOptions, f as GetPostBySlugResponse, L as ListPostsOptions, g as ListPostsResponse, h as QueryPostsOptions, P 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-DQPJ111E.mjs';
-export { c6 as ActionEvent, A as Alignment, be as AnchorData, bk as AppEmbedData, bl as AppEmbedDataAppDataOneOf, H as AppType, bz as AudioData, b4 as Background, b5 as BackgroundBackgroundOneOf, D as BackgroundType, d5 as BaseEventMetadata, bC as BlockquoteData, cb as BlogPaging, bm as BookingData, ak as Border, bx as BorderColors, cJ as BulkGetPostMetricsRequest, cK as BulkGetPostMetricsResponse, cX as BulkGetPostReactionsRequest, cY as BulkGetPostReactionsResponse, bB as BulletedListData, aj as ButtonData, bD as CaptionData, ce as Category, cf as CategoryTranslation, bw as CellStyle, av as CodeBlockData, bs as CollapsibleListData, bf as ColorData, al as Colors, d0 as ConvertDraftJsToRichContentRequest, d1 as ConvertDraftJsToRichContentResponse, d2 as ConvertRichContentToDraftJsRequest, d3 as ConvertRichContentToDraftJsResponse, a6 as CoverMedia, a7 as CoverMediaMediaOneOf, ci as CreateDraftPostFromTemplateRequest, cj as CreateDraftPostFromTemplateResponse, C as Crop, cE as CursorPaging, cH as Cursors, bc as Decoration, bd as DecorationDataOneOf, E as DecorationType, ba as Design, bu as Dimensions, J as Direction, ax as DividerData, bG as DocumentStyle, c0 as DomainEvent, c1 as DomainEventBodyOneOf, ck as DraftPost, cl as DraftPostTranslation, bq as EmbedData, bN as EmbedMedia, bO as EmbedThumbnail, bP as EmbedVideo, c2 as EntityCreatedEvent, c5 as EntityDeletedEvent, c4 as EntityUpdatedEvent, bn as EventData, d6 as EventMetadata, a1 as Field, ay as FileData, az as FileSource, aA as FileSourceDataOneOf, a8 as FocalPoint, bi as FontSizeData, F as FontType, aN as GIF, aM as GIFData, v as GIFType, aC as GalleryData, aI as GalleryOptions, cx as GetPostBySlugRequest, cI as GetPostMetricsRequest, cw as GetPostRequest, _ as GetPostTemplatesSort, a3 as GetPostsSort, cg as GetTemplateRequest, ch as GetTemplateResponse, cm as GetTotalLikesPerMemberRequest, cn as GetTotalLikesPerMemberResponse, b$ as GetTotalPostsRequest, bZ as GetTotalPublicationsRequest, b_ as GetTotalPublicationsResponse, b3 as Gradient, aP as HTMLData, aQ as HTMLDataDataOneOf, aO as HeadingData, aq as Height, c8 as IdentificationData, c9 as IdentificationDataIdOneOf, aE as Image, aR as ImageData, aT as ImageDataStyles, I as InitialExpandedItems, cv as InitialPostsCopied, aG as Item, aH as ItemDataOneOf, aK as ItemStyle, ac as Keyword, aJ as Layout, bE as LayoutCellData, t as LayoutType, cN as LikePostRequest, cO as LikePostResponse, r as LineStyle, as as Link, bg as LinkData, at as LinkDataOneOf, aU as LinkPreviewData, aV as LinkPreviewDataStyles, c_ as ListDemoPostsRequest, c$ as ListDemoPostsResponse, cV as ListPostsArchiveRequest, cW as ListPostsArchiveResponse, cy as ListPostsRequest, ca as ListTemplatesRequest, cc as ListTemplatesResponse, by as ListValue, aW as MapData, aX as MapSettings, M as MapType, bJ as Media, bK as MediaMediaOneOf, bh as MentionData, c7 as MessageEnvelope, cd as MetaData, bF as Metadata, aa as Metrics, bI as ModerationDetails, U as ModerationStatusStatus, ag as Node, ah as NodeDataOneOf, ai as NodeStyle, N as NodeType, R as NullValue, br as Oembed, d4 as OldBlogMigratedEvent, a$ as Option, b7 as OptionDesign, b2 as OptionLayout, Y as Order, bA as OrderedListData, O as Orientation, $ as Origin, aB as PDFSettings, cD as Paging, cG as PagingMetadataV2, aY as ParagraphData, bY as PeriodPostCount, bW as PeriodPublicationsCount, a_ as Permissions, cR as PinPostRequest, cS as PinPostResponse, cB as PlatformQuery, cC as PlatformQueryPagingMethodOneOf, bp as PlaybackOptions, am as PluginContainerData, o as PluginContainerDataAlignment, an as PluginContainerDataWidth, ao as PluginContainerDataWidthDataOneOf, b8 as Poll, aZ as PollData, b9 as PollDataLayout, b6 as PollDesign, b1 as PollLayout, B as PollLayoutDirection, z as PollLayoutType, b0 as PollSettings, w as Position, a5 as Post, bR as PostCategoriesUpdated, a9 as PostCountInfo, cs as PostCountersUpdated, ct as PostCountersUpdatedInitiatorOneOf, a2 as PostFieldField, co as PostLiked, cp as PostLikedInitiatorOneOf, cu as PostOwnerChanged, bS as PostTagsUpdated, bQ as PostTranslation, cq as PostUnliked, cr as PostUnlikedInitiatorOneOf, d7 as PostsQueryResult, bX as QueryPostCountStatsRequest, cz as QueryPostsRequest, cF as QueryPostsResponse, bU as QueryPublicationsCountStatsRequest, X as QueryPublicationsCountStatsRequestOrder, bV as QueryPublicationsCountStatsResponse, cZ as Reactions, au as Rel, c3 as RestoreInfo, af as RichContent, bT as ScheduledPostPublished, ab as SeoSchema, ae as Settings, a4 as SortOrder, cA as Sorting, S as Source, ap as Spoiler, bj as SpoilerData, a0 as Status, ar as Styles, aS as StylesBorder, bv as TableCellData, bt as TableData, ad as Tag, p as Target, q as TextAlignment, bb as TextData, bH as TextNodeStyle, aw as TextStyle, aL as Thumbnails, u as ThumbnailsAlignment, T as Type, cP as UnlikePostRequest, cQ as UnlikePostResponse, cT as UnpinPostRequest, cU as UnpinPostResponse, aD as V1Media, K as VerticalAlignment, aF as Video, bo as VideoData, bM 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, bL as WixMedia } from './blog-v3-post-posts.universal-DQPJ111E.mjs';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { QueryPostCountStatsOptions, QueryPostCountStatsResponse, GetTotalPostsOptions, GetTotalPostsResponse, GetPostOptions, GetPostResponse, GetPostBySlugOptions, GetPostBySlugResponse, ListPostsOptions, ListPostsResponse, QueryPostsOptions, PostsQueryBuilder, GetPostMetricsResponse, PostCreatedEnvelope, PostDeletedEnvelope, PostLikedEnvelope, PostUnlikedEnvelope, PostUpdatedEnvelope } from './index.typings.mjs';
+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.mjs';
 
+type PostNonNullablePaths = `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`;
 declare function queryPostCountStats$1(httpClient: HttpClient): QueryPostCountStatsSignature;
 interface QueryPostCountStatsSignature {
     /**
@@ -16,7 +17,7 @@ interface QueryPostCountStatsSignature {
      * @param - Options specifying time frame, sort, and filter.
      * @returns Get Blog Post Count Stats response
      */
-    (options?: QueryPostCountStatsOptions | undefined): Promise<QueryPostCountStatsResponse>;
+    (options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`>>;
 }
 declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature;
 interface GetTotalPostsSignature {
@@ -24,7 +25,7 @@ interface GetTotalPostsSignature {
      * Retrieves the total amount of published posts of the blog.
      * @param - Language Options.
      */
-    (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse>;
+    (options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`>>;
 }
 declare function getPost$1(httpClient: HttpClient): GetPostSignature;
 interface GetPostSignature {
@@ -33,7 +34,9 @@ interface GetPostSignature {
      * @param - Post ID.
      * @param - Options specifying which fields to return.
      */
-    (postId: string, options?: GetPostOptions | undefined): Promise<GetPostResponse>;
+    (postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, {
+        [P in PostNonNullablePaths]: `post.${P}`;
+    }[PostNonNullablePaths]>>;
 }
 declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
 interface GetPostBySlugSignature {
@@ -47,7 +50,9 @@ interface GetPostBySlugSignature {
      * @param - Slug of the post to retrieve.
      * @param - Options specifying which fields to return.
      */
-    (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse>;
+    (slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
+        [P in PostNonNullablePaths]: `post.${P}`;
+    }[PostNonNullablePaths]>>;
 }
 declare function listPosts$1(httpClient: HttpClient): ListPostsSignature;
 interface ListPostsSignature {
@@ -60,7 +65,9 @@ interface ListPostsSignature {
      * - `paging.offset` is `0`.
      * @param - Sort, filter, and paging options.
      */
-    (options?: ListPostsOptions | undefined): Promise<ListPostsResponse>;
+    (options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
+        [P in PostNonNullablePaths]: `posts.${number}.${P}`;
+    }[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
 }
 declare function queryPosts$1(httpClient: HttpClient): QueryPostsSignature;
 interface QueryPostsSignature {
@@ -85,7 +92,7 @@ interface QueryPostsSignature {
      * 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;
+    (options?: QueryPostsOptions): PostsQueryBuilder;
 }
 declare function getPostMetrics$1(httpClient: HttpClient): GetPostMetricsSignature;
 interface GetPostMetricsSignature {
@@ -95,7 +102,7 @@ interface GetPostMetricsSignature {
      * A post's metrics include the comments, likes, and views the post receives.
      * @param - Post ID to retrieve metrics for.
      */
-    (postId: string): Promise<GetPostMetricsResponse>;
+    (postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`>>;
 }
 declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
 declare const onPostDeleted$1: EventDefinition<PostDeletedEnvelope, "wix.blog.v3.post_deleted">;