@wix/auto_sdk_blog_posts 1.0.31 → 1.0.33

package/build/internal/cjs/index.d.ts

@@ -1 +1,127 @@
-export * from './src/blog-v3-post-posts.context.js';
+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-D8MomLjA.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-D8MomLjA.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.
+     * @returns Get Blog Post Count Stats response
+     */
+    (options?: QueryPostCountStatsOptions | undefined): Promise<QueryPostCountStatsResponse>;
+}
+declare function getTotalPosts$1(httpClient: HttpClient): GetTotalPostsSignature;
+interface GetTotalPostsSignature {
+    /**
+     * Retrieves the total amount of published posts of the blog.
+     */
+    (options?: GetTotalPostsOptions | undefined): Promise<GetTotalPostsResponse>;
+}
+declare function getPost$1(httpClient: HttpClient): GetPostSignature;
+interface GetPostSignature {
+    /**
+     * Retrieves a post by the specified ID.
+     * @param - Post ID.
+     * @returns Retrieved post info.
+     */
+    (postId: string, options?: GetPostOptions | undefined): Promise<Post>;
+}
+declare function getPostBySlug$1(httpClient: HttpClient): GetPostBySlugSignature;
+interface GetPostBySlugSignature {
+    /**
+     * Retrieves a post with the provided slug.
+     *
+     * The slug is the end of a post's URL that refers to a specific post.
+     * For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
+     * 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.
+     */
+    (slug: string, options?: GetPostBySlugOptions | undefined): Promise<GetPostBySlugResponse>;
+}
+declare function listPosts$1(httpClient: HttpClient): ListPostsSignature;
+interface ListPostsSignature {
+    /**
+     * Retrieves a list of up to 100 published posts per request.
+     *
+     * List 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`.
+     */
+    (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.
+     *
+     * 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).
+     *
+     * 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).
+     */
+    (options?: QueryPostsOptions | undefined): PostsQueryBuilder;
+}
+declare function getPostMetrics$1(httpClient: HttpClient): GetPostMetricsSignature;
+interface GetPostMetricsSignature {
+    /**
+     * Retrieves a post's metrics.
+     *
+     * A post's metrics include the comments, likes, and views the post receives.
+     * @param - Post ID to retrieve metrics for.
+     */
+    (postId: string): Promise<GetPostMetricsResponse>;
+}
+declare const onPostCreated$1: EventDefinition<PostCreatedEnvelope, "wix.blog.v3.post_created">;
+declare const onPostDeleted$1: EventDefinition<PostDeletedEnvelope, "wix.blog.v3.post_deleted">;
+declare const onPostLiked$1: EventDefinition<PostLikedEnvelope, "wix.blog.v3.post_liked">;
+declare const onPostUnliked$1: EventDefinition<PostUnlikedEnvelope, "wix.blog.v3.post_unliked">;
+declare const onPostUpdated$1: EventDefinition<PostUpdatedEnvelope, "wix.blog.v3.post_updated">;
+
+declare const queryPostCountStats: MaybeContext<BuildRESTFunction<typeof queryPostCountStats$1> & typeof queryPostCountStats$1>;
+declare const getTotalPosts: MaybeContext<BuildRESTFunction<typeof getTotalPosts$1> & typeof getTotalPosts$1>;
+declare const getPost: MaybeContext<BuildRESTFunction<typeof getPost$1> & typeof getPost$1>;
+declare const getPostBySlug: MaybeContext<BuildRESTFunction<typeof getPostBySlug$1> & typeof getPostBySlug$1>;
+declare const listPosts: MaybeContext<BuildRESTFunction<typeof listPosts$1> & typeof listPosts$1>;
+declare const queryPosts: MaybeContext<BuildRESTFunction<typeof queryPosts$1> & typeof queryPosts$1>;
+declare const getPostMetrics: MaybeContext<BuildRESTFunction<typeof getPostMetrics$1> & typeof getPostMetrics$1>;
+/**
+ * Triggered when a post is created.
+ */
+declare const onPostCreated: BuildEventDefinition<typeof onPostCreated$1>;
+/**
+ * Triggered when a post is deleted.
+ */
+declare const onPostDeleted: BuildEventDefinition<typeof onPostDeleted$1>;
+/**
+ * Triggered when a post is liked.
+ */
+declare const onPostLiked: BuildEventDefinition<typeof onPostLiked$1>;
+/**
+ * Triggered when a post is unliked.
+ */
+declare const onPostUnliked: BuildEventDefinition<typeof onPostUnliked$1>;
+/**
+ * Triggered when a post is updated.
+ */
+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 };