@wix/auto_sdk_blog_posts 1.0.9 → 1.0.11

package/build/es/src/blog-v3-post-posts.universal.d.ts

@@ -34,11 +34,7 @@ export interface Post {
     /** Post URL. */
     url?: string;
     /**
-     * Part of a post's URL that refers to a specific post.
-     *
-     *
-     * For example, `'https:/example.com/posts/my-post-slug'`.
-     *
+     * Post slug. For example, `'post-slug'`.
      * @maxLength 100
      */
     slug?: string;
@@ -47,22 +43,23 @@ export interface Post {
     /** Whether the post is pinned. If `true`, the post is placed at the top of the post list. */
     pinned?: boolean;
     /**
-     * [Category IDs](https://www.wix.com/velo/reference/wix-blog-backend/categories) of the post.
-     *
+     * [Category IDs](https://dev.wix.com/docs/rest/business-solutions/blog/category/introduction) of the post.
      * @maxSize 10
      * @format GUID
      */
     categoryIds?: string[];
     /**
-     * Reserved for internal use.
+     * __Deprecated.__ Use `media` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Post cover media.
      * @deprecated
      * @replacedBy media
      * @targetRemovalDate 2024-06-30
      */
     coverMedia?: CoverMedia;
     /**
-     * Post owner's [member ID](https://www.wix.com/velo/reference/wix-members-backend).
-     *
+     * Post owner's [member ID](https://dev.wix.com/api/rest/members).
      * @format GUID
      */
     memberId?: string;
@@ -75,13 +72,12 @@ export interface Post {
     hashtags?: string[];
     /** Whether commenting on the post is enabled. */
     commentingEnabled?: boolean;
-    /** Estimated reading time. */
+    /** Estimated reading time (calculated automatically). */
     minutesToRead?: number;
-    /** Image placed at the top of the blog page. Only displays on mobile devices.  */
+    /** Image placed at the top of the blog page. */
     heroImage?: string;
     /**
-     * IDs of [tags](https://www.wix.com/velo/reference/wix-blog-backend/tags) the post is tagged with.
-     *
+     * IDs of [tags](https://dev.wix.com/docs/rest/business-solutions/blog/tags) the post is tagged with.
      * @readonly
      * @maxSize 30
      * @format GUID
@@ -95,17 +91,14 @@ export interface Post {
      */
     relatedPostIds?: string[];
     /**
-     * Pricing plan IDs.
-     *
-     *
-     * If a post is assigned to a specific pricing plan.
+     * [Pricing plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans). Only relevant if a post is assigned to a specific pricing plan.
      * @readonly
      * @maxSize 100
      * @format GUID
      */
     pricingPlanIds?: string[];
     /**
-     * ID of the post's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single post will share the same `translationId`.
+     * ID of the translations of this post. All translations of a single post share the same `translationId`.
      * @format GUID
      */
     translationId?: string | null;
@@ -125,8 +118,7 @@ export interface Post {
      */
     content?: string | null;
     /**
-     * Post owner's [contact ID](https://www.wix.com/velo/reference/wix-crm-backend/contacts).
-     *
+     * Post owner's [contact ID](https://dev.wix.com/api/rest/contacts).
      * @format GUID
      */
     contactId?: string | null;
@@ -157,10 +149,7 @@ export interface Post {
      */
     mostRecentContributorId?: string | null;
     /**
-     * Post moderation details.
-     *
-     *
-     * Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers). Guest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or site owner.
+     * Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).
      * @readonly
      */
     moderationDetails?: ModerationDetails;
@@ -194,11 +183,7 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
     enabled?: boolean;
     /** Whether cover media is displayed. */
     displayed?: boolean;
-    /**
-     * Whether the cover media is custom.
-     *
-     * `false` if the cover media is the first image or video in the post. `true` if set to some other image or video.
-     */
+    /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
     custom?: boolean;
     /**
      * Media alternative text.
@@ -1673,11 +1658,11 @@ export interface TextNodeStyle {
 }
 export interface ModerationDetails {
     /**
-     * Member ID of the person who submitted the post.
+     * Member ID of the person submitting the draft post for review.
      * @format GUID
      */
     submittedBy?: string;
-    /** Date and time the post was submitted for moderation. */
+    /** Date the post was submitted for review. */
     submittedDate?: Date | null;
     /** Status indicating whether the submission was approved or rejected by the moderator. */
     status?: ModerationStatusStatus;
@@ -1686,7 +1671,7 @@ export interface ModerationDetails {
      * @format GUID
      */
     moderatedBy?: string | null;
-    /** Date and time the post was approved or rejected by a moderator. */
+    /** Date the post was approved or rejected. */
     moderationDate?: Date | null;
 }
 export declare enum ModerationStatusStatus {
@@ -1701,11 +1686,7 @@ export interface Media extends MediaMediaOneOf {
     embedMedia?: EmbedMedia;
     /** Whether cover media is displayed. */
     displayed?: boolean;
-    /**
-     * Whether the cover media is custom.
-     *
-     * `false` if the cover media is the first image or video in the post. `true` if set to some other image or video.
-     */
+    /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
     custom?: boolean;
     /**
      * Media alternative text.
@@ -1890,8 +1871,8 @@ export interface QueryPostCountStatsRequest {
     /**
      * Language filter.
      *
-     *
-     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * Pass a language to only receive the period post count for that specified language.
      * @format LANGUAGE_TAG
      */
     language?: string | null;
@@ -1911,7 +1892,7 @@ export declare enum Order {
 }
 /** Get Blog Post Count Stats response */
 export interface QueryPostCountStatsResponse {
-    /** List of posts in specified order. */
+    /** List of published post counts by month. */
     stats?: PeriodPostCount[];
 }
 /** Post count for a specific time period */
@@ -1937,8 +1918,8 @@ export interface GetTotalPostsRequest {
     /**
      * Language filter.
      *
-     *
-     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * Pass a language to receive the total amount of posts in that specified language.
      * @format LANGUAGE_TAG
      */
     language?: string | null;
@@ -2146,11 +2127,7 @@ export interface ListTemplatesResponse {
 export interface MetaData {
     /** Number of items returned in this response. */
     count?: number;
-    /**
-     * Number of items skipped in the current sort order.
-     *
-     *
-     */
+    /** Requested offset. */
     offset?: number;
     /** Total number of items that match the query. */
     total?: number;
@@ -2644,7 +2621,9 @@ export interface GetPostRequest {
      */
     postId: string;
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[];
@@ -2678,7 +2657,9 @@ export interface GetPostBySlugRequest {
      */
     slug: string;
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[];
@@ -2721,15 +2702,20 @@ export interface ListPostsRequest {
      * @maxLength 38
      */
     tagIds?: string[];
-    /** Sort order by descending view count, ascending or descending publish date, or default to descending by publish date with pinned posts first. */
+    /**
+     * Sorting options.
+     *
+     * Default: `FEED`
+     */
     sort?: GetPostsSort;
     /** Pagination options. */
     paging?: BlogPaging;
     /**
      * Language filter.
      *
-     *
-     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * Pass a language to only receive posts that are in that language.
+     * If omitted, posts in all languages are returned.
      * @format LANGUAGE_TAG
      */
     language?: string | null;
@@ -2739,7 +2725,9 @@ export interface ListPostsRequest {
      */
     memberId?: string | null;
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[];
@@ -2770,7 +2758,9 @@ export interface QueryPostsRequest {
     /** Query options. */
     query?: PlatformQuery;
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[];
@@ -3501,7 +3491,7 @@ interface PostTranslationNonNullableFields {
     seoData?: SeoSchemaNonNullableFields;
     url: string;
 }
-interface PostNonNullableFields {
+export interface PostNonNullableFields {
     _id: string;
     title: string;
     excerpt: string;
@@ -3704,15 +3694,14 @@ export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => v
 /**
  * Retrieves the number of published posts per month within a specified time range.
  *
- *
- * 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.
+ * 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.
  * @public
  * @documentationMaturity preview
- * @param options - Options specifying time frame, sort, and filter.
  * @permissionId BLOG.READ-PUBLICATION
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3722,7 +3711,7 @@ export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => v
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - Post count stats.
+ * @returns Get Blog Post Count Stats response
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
  */
 export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<QueryPostCountStatsResponse & QueryPostCountStatsResponseNonNullableFields>;
@@ -3730,10 +3719,12 @@ export interface QueryPostCountStatsOptions {
     /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
     rangeStart?: Date | null;
     /**
-     * Sort order.
-     * Use `'ASC'` for ascending order or `'DESC'` for descending order.
+     * Order of returned results.
      *
-     * Default: `ASC`
+     * - `OLDEST`: posts by date in ascending order.
+     * - `NEWEST`: posts by date in descending order.
+     *
+     * Default: `OLDEST`
      */
     order?: Order;
     /** Number of months to include in response. */
@@ -3741,8 +3732,8 @@ export interface QueryPostCountStatsOptions {
     /**
      * Language filter.
      *
-     *
-     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * Pass a language to only receive the period post count for that specified language.
      * @format LANGUAGE_TAG
      */
     language?: string | null;
@@ -3756,16 +3747,9 @@ export interface QueryPostCountStatsOptions {
     timeZone?: string | null;
 }
 /**
- * Gets the total amount of published posts on the blog.
- *
- *
- * The `getTotalPosts()` function returns a Promise that resolves to the total amount of published posts on your blog's site.
- *
- *
- * You can use the `language` option to filter posts for a specified language.
+ * Retrieves the total amount of published posts of the blog.
  * @public
  * @documentationMaturity preview
- * @param options - Language Options.
  * @permissionId BLOG.READ-PUBLICATION
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3775,7 +3759,6 @@ export interface QueryPostCountStatsOptions {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - Total number of posts.
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
  */
 export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
@@ -3783,22 +3766,17 @@ export interface GetTotalPostsOptions {
     /**
      * Language filter.
      *
-     *
-     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * Pass a language to receive the total amount of posts in that specified language.
      * @format LANGUAGE_TAG
      */
     language?: string | null;
 }
 /**
- * Gets a post by the specified ID.
- *
- *
- * The `getPost()` function returns a Promise that resolves to a post whose ID matches the given ID.
- *
+ * Retrieves a post by the specified ID.
  * @param postId - Post ID.
  * @public
  * @requiredField postId
- * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3808,30 +3786,29 @@ export interface GetTotalPostsOptions {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - The requested post.
+ * @returns Retrieved post info.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
  */
-export declare function getPost(postId: string, options?: GetPostOptions): Promise<GetPostResponse & GetPostResponseNonNullableFields>;
+export declare function getPost(postId: string, options?: GetPostOptions): Promise<Post & PostNonNullableFields>;
 export interface GetPostOptions {
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[];
 }
 /**
- * Gets a post by the provided slug.
- *
- *
- * The `getPostBySlug()` function returns a Promise that resolves to a post whose slug matches the given slug.
+ * 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.
+ * 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 - Slug of the post to retrieve.
  * @public
  * @requiredField slug
- * @param options - Options specifying which fields to return.
- * @param slug - Slug of the post to retrieve.
- *
- * The end of a post's URL, for example, `https:/example.com/blog/post/my-post-slug`. Case sensitive and generally based on the post title if not specified.
  * @permissionId BLOG.READ-PUBLICATION
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3841,28 +3818,26 @@ export interface GetPostOptions {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - The requested post.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
  */
 export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
 export interface GetPostBySlugOptions {
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[];
 }
 /**
- * Retrieves a list of published posts.
- *
- *
- * The `listPosts()` function returns a Promise that resolves to a list of up to 100 published posts.
+ * Retrieves a list of up to 100 published posts per request.
  *
- * Using the `options` parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.
- *
- * By default, the list is sorted by `firstPublishedDate` in descending order, and the amount of posts returned is 50.
+ * 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`.
  * @public
- * @param options - Sort, filter, and paging options.
  * @permissionId BLOG.READ-PUBLICATION
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3872,52 +3847,47 @@ export interface GetPostBySlugOptions {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - List of retrieved posts.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
  */
 export declare function listPosts(options?: ListPostsOptions): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
 export interface ListPostsOptions {
-    /** Featured filter. Whether to return only featured posts. */
-    featured?: boolean;
     /**
-     * List of hashtags to filter for.
+     * Whether to return only featured posts.
      *
+     * Default: `false`
+     */
+    featured?: boolean;
+    /**
+     * Hashtag filter.
      *
-     * Default: All hashtags
+     * Pass an array of hashtags to return only posts containing any of the provided hashtags.
+     * If omitted, all posts with or without hashtags are returned.
      * @maxSize 100
      * @maxLength 100
      */
     hashtags?: string[];
     /**
-     * List of category IDs to filter for.
-     *
+     * Category filter.
      *
-     * Default: All categories
+     * Pass an array of category IDs to return only posts with any of the provided categories.
+     * If omitted, all posts with or without associated categories are returned.
      * @maxSize 50
      * @maxLength 38
      */
     categoryIds?: string[];
     /**
-     * List of [tag IDs](https://www.wix.com/velo/reference/wix-blog-backend/tags) to filter for.
-     *
+     * Tag filter.
      *
-     * Default: All tags
+     * Pass an array of tag IDs to return only posts with any of the provided tags.
+     * If omitted, all posts with or without tags are returned.
      * @maxSize 50
      * @maxLength 38
      */
     tagIds?: string[];
     /**
-     * Sort order.
-     *
-     * Sort by one of the following:
-     *  - `'VIEW_COUNT'` descending view count
-     *  - `'LIKE_COUNT'` descending like count
-     *  - `'PUBLISHED_DATE_ASC'` ascending published date
-     *  - `'PUBLISHED_DATE_DESC'` descending published date
-     *  - `'TITLE_ASC'` ascending title
-     *  - `'TITLE_DESC'` descending title
+     * Sorting options.
      *
-     *  Default: `'PUBLISHED_DATE_DESC'`
+     * Default: `FEED`
      */
     sort?: GetPostsSort;
     /** Pagination options. */
@@ -3925,46 +3895,43 @@ export interface ListPostsOptions {
     /**
      * Language filter.
      *
-     *
-     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * Pass a language to only receive posts that are in that language.
+     * If omitted, posts in all languages are returned.
      * @format LANGUAGE_TAG
      */
     language?: string | null;
     /**
-     * Member ID to filter for.
-     *
-     *
-     * Default: All members
+     * Post owner's member ID.
      * @format GUID
      */
     memberId?: string | null;
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[];
 }
 /**
- * Creates a query to retrieve a list of posts.
- *
- *
- * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder) object.
- *
- * The returned object contains the query definition which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/find) function.
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
  *
- * 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.
+ * 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`.
  *
- * `queryPosts()` runs with these `PostsQueryBuilder` defaults that can be overridden:
- * + [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/limit)
- * + [`descending('firstPublishedDate')`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/descending)
+ * 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).
  *
- * Note that the default limit is `'50'`, but the max limit is `'100'`.
- *
- * To learn how to query posts, refer to the table below.
- *
- * 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`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult/items) property in [`PostsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult).
+ * 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).
  * @public
- * @param options - Options specifying which fields to return.
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
  * @permissionScope Manage Blog
@@ -3979,7 +3946,9 @@ export interface ListPostsOptions {
 export declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
 export interface QueryPostsOptions {
     /**
-     * List of post fields to be included in the response. By default, any fields not passed are not returned.
+     * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
+     * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
+     * only the post’s base fields are returned.
      * @maxSize 20
      */
     fieldsets?: PostFieldField[] | undefined;
@@ -4047,10 +4016,7 @@ export interface PostsQueryBuilder {
     find: () => Promise<PostsQueryResult>;
 }
 /**
- * Gets a specified post's metrics.
- *
- *
- * The `getPostMetrics()` function returns a Promise that resolves to the specified post's metrics.
+ * Retrieves a post's metrics.
  *
  * A post's metrics include the comments, likes, and views the post receives.
  * @param postId - Post ID to retrieve metrics for.
@@ -4065,7 +4031,6 @@ export interface PostsQueryBuilder {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Fulfilled - Post metrics.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
  */
 export declare function getPostMetrics(postId: string): Promise<GetPostMetricsResponse & GetPostMetricsResponseNonNullableFields>;