@wix/auto_sdk_blog_posts 1.0.167 → 1.0.169

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

@@ -65,6 +65,14 @@ interface Post {
     hashtags?: string[];
     /** Whether commenting on the post is enabled. */
     commentingEnabled?: boolean;
+    /**
+     * Dynamic post count info Comment Count, Like Count, View Count.
+     * @internal
+     * @deprecated Dynamic post count info Comment Count, Like Count, View Count.
+     * @replacedBy metrics
+     * @targetRemovalDate 2024-06-30
+     */
+    postCountInfo?: PostCountInfo;
     /** Estimated reading time (calculated automatically). */
     minutesToRead?: number;
     /** Image placed at the top of the blog page. Only displays on mobile devices. */
@@ -104,8 +112,22 @@ interface Post {
      * @format LANGUAGE_TAG
      */
     language?: string | null;
+    /**
+     * Post metrics.
+     * Deprecated on '2022-02-15', data can be inconsistent, for consistent data please use 'PostService#GetPostMetrics' API instead
+     * @internal
+     * @deprecated
+     */
+    metrics?: Metrics;
     /** SEO data. */
     seoData?: SeoSchema;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 400000
+     */
+    content?: string | null;
     /**
      * Contact ID of the post's owner. See the Contacts API for more info.
      * @format GUID
@@ -126,6 +148,19 @@ interface Post {
      * @readonly
      */
     preview?: boolean;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @maxLength 24
+     */
+    contentId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @format GUID
+     */
+    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).
      *
@@ -142,17 +177,68 @@ interface Post {
      * @maxLength 8000000
      */
     richContentString?: string | null;
+    /**
+     * Post rich content as compressed binary data
+     * @internal
+     * @readonly
+     */
+    richContentCompressed?: Uint8Array | null;
     /**
      * Indicates if there is a draft post with changes that have not yet been published.
      * @readonly
      */
     hasUnpublishedChanges?: boolean;
+    /**
+     * List of the post's translated posts.
+     * @internal
+     * @readonly
+     * @maxSize 1000
+     */
+    translations?: PostTranslation[];
+    /**
+     * Identifies whether excerpt was set by contributor.
+     * True - excerpt was set by contributor.
+     * False - excerpt was generated from content.
+     * @internal
+     * @readonly
+     */
+    customExcerpt?: boolean;
     /**
      * Post reference ID. You can reference the post from other entities, for example, comments.
      * @readonly
      * @maxLength 24
      */
     referenceId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 24
+     */
+    internalId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxSize 10
+     * @maxLength 24
+     */
+    internalCategoryIds?: string[];
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxSize 3
+     * @maxLength 24
+     */
+    internalRelatedPostIds?: string[];
+    /**
+     * Identifies if post is created from template
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     */
+    isDemo?: boolean | null;
 }
 interface PostCountInfo {
     /**
@@ -197,6 +283,18 @@ interface Metrics {
      * @readonly
      */
     views?: number;
+    /**
+     * Total number of post ratings.
+     * @internal
+     * @readonly
+     */
+    totalRatings?: number;
+    /**
+     * Average rating of post from 1 to 5.
+     * @internal
+     * @readonly
+     */
+    averageRating?: number;
 }
 /**
  * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
@@ -2910,8 +3008,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: string;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 interface EmbedMedia {
     /** Thumbnail details. */
@@ -3282,6 +3440,20 @@ interface PeriodPublicationsCount {
 interface QueryPostCountStatsRequest {
     /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
     rangeStart?: Date | null;
+    /**
+     * __Deprecated.__ Use `months` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format.
+     * @internal
+     * @deprecated __Deprecated.__ Use `months` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format.
+     * @replacedBy months
+     * @targetRemovalDate 2024-06-30
+     */
+    rangeEnd?: Date | null;
     /**
      * Order of returned results.
      *
@@ -3371,6 +3543,12 @@ interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
      * @format GUID
      */
     postId?: string;
+    /**
+     * Internal ID of the post which counters were updated.
+     * @internal
+     * @maxLength 24
+     */
+    postInternalId?: string;
     /** Field of the updated counter. */
     updatedCounterField?: FieldWithLiterals;
     /** New counter value. */
@@ -3404,6 +3582,18 @@ declare enum Field {
 /** @enumType */
 type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
 interface PostOwnerChanged {
+    /**
+     * Member ID of the post's owner before the change.
+     * @internal
+     * @format GUID
+     */
+    oldMemberId?: string;
+    /**
+     * Member ID of the post's owner after the change.
+     * @internal
+     * @format GUID
+     */
+    newMemberId?: string;
 }
 interface InitialPostsCopied {
     /** Number of posts copied. */
@@ -3416,6 +3606,21 @@ interface GetPostRequest {
      * @maxLength 38
      */
     postId: string;
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @maxSize 20
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
+     */
+    fieldsToInclude?: PostFieldFieldWithLiterals[];
     /**
      * 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
@@ -3426,6 +3631,11 @@ interface GetPostRequest {
 }
 declare enum PostFieldField {
     UNKNOWN = "UNKNOWN",
+    /**
+     * Deprecated use `METRICS` instead.
+     * @internal
+     */
+    COUNTERS = "COUNTERS",
     /** Includes post URL when present. */
     URL = "URL",
     /** Includes post content text string when present. */
@@ -3434,12 +3644,69 @@ declare enum PostFieldField {
     METRICS = "METRICS",
     /** Includes SEO data. */
     SEO = "SEO",
+    /**
+     * Includes post content as a stringified DraftJS document.
+     * Reserved for internal use.
+     * @internal
+     */
+    CONTENT = "CONTENT",
+    /**
+     * Includes internal ID field.
+     * Reserved for internal use.
+     * @internal
+     */
+    INTERNAL_ID = "INTERNAL_ID",
     /** Includes post owner's contact ID. */
     CONTACT_ID = "CONTACT_ID",
     /** Includes post rich content. */
     RICH_CONTENT = "RICH_CONTENT",
+    /**
+     * Includes post rich content string.
+     * @internal
+     */
+    RICH_CONTENT_STRING = "RICH_CONTENT_STRING",
+    /**
+     * Includes compressed post rich content string.
+     * @internal
+     */
+    RICH_CONTENT_COMPRESSED = "RICH_CONTENT_COMPRESSED",
+    /**
+     * Includes post translations.
+     * @internal
+     */
+    TRANSLATIONS = "TRANSLATIONS",
     /** Includes post reference ID field. */
-    REFERENCE_ID = "REFERENCE_ID"
+    REFERENCE_ID = "REFERENCE_ID",
+    /**
+     * If provided, all content fields exclude paid content.
+     * @internal
+     */
+    EXCLUDE_PAID_CONTENT = "EXCLUDE_PAID_CONTENT",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    SEO_DATA = "SEO_DATA",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    OWNER = "OWNER",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    HAS_UNPUBLISHED_CHANGES = "HAS_UNPUBLISHED_CHANGES",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    HEADING = "HEADING",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    IMAGE = "IMAGE"
 }
 /** @enumType */
 type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
@@ -3454,6 +3721,21 @@ interface GetPostBySlugRequest {
      * @maxLength 200
      */
     slug: string;
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @maxSize 20
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
+     */
+    fieldsToInclude?: PostFieldFieldWithLiterals[];
     /**
      * 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
@@ -3513,6 +3795,21 @@ interface ListPostsRequest {
     sort?: GetPostsSortWithLiterals;
     /** Pagination options. */
     paging?: BlogPaging;
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @maxSize 20
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
+     */
+    fieldsToInclude?: PostFieldFieldWithLiterals[];
     /**
      * Language filter.
      *
@@ -3549,7 +3846,12 @@ declare enum GetPostsSort {
     /** Ordered by `title` in ascending order. */
     TITLE_ASC = "TITLE_ASC",
     /** Ordered by `title` in descending order. */
-    TITLE_DESC = "TITLE_DESC"
+    TITLE_DESC = "TITLE_DESC",
+    /**
+     * Sorting by post rating descending.
+     * @internal
+     */
+    RATING = "RATING"
 }
 /** @enumType */
 type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
@@ -3596,6 +3898,64 @@ interface MetaData {
     cursor?: string | null;
 }
 interface QueryPostsRequest {
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    paging?: BlogPaging;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @internal
+     * @maxSize 3
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    sort?: Sorting[];
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @maxSize 20
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
+     */
+    fieldsToInclude?: PostFieldFieldWithLiterals[];
     /** Query options. */
     query?: PlatformQuery;
     /**
@@ -3614,6 +3974,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -3688,6 +4062,20 @@ interface CursorPaging {
 interface QueryPostsResponse {
     /** List of retrieved posts. */
     posts?: Post[];
+    /**
+     * __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @internal
+     * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @replacedBy pagingMetadata
+     * @targetRemovalDate 2024-06-30
+     */
+    metaData?: MetaData;
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadataV2;
 }
@@ -3702,6 +4090,13 @@ interface PagingMetadataV2 {
     tooManyToCount?: boolean | null;
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     * @internal
+     */
+    hasNext?: boolean | null;
 }
 interface Cursors {
     /**
@@ -4189,14 +4584,13 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
 /**
  * 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
- * @param options - Options specifying time frame, sort, and filter.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
  * @returns Get Blog Post Count Stats response
@@ -4237,7 +4631,6 @@ interface QueryPostCountStatsOptions {
 /**
  * Retrieves the total amount of published posts of the blog.
  * @public
- * @param options - Language Options.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -4258,12 +4651,12 @@ interface GetTotalPostsOptions {
  * @param postId - Post ID.
  * @public
  * @requiredField postId
- * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
+ * @returns Retrieved post info.
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
  */
-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`, 7>>;
+declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `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`, 6>>;
 interface GetPostOptions {
     /**
      * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4283,7 +4676,6 @@ interface GetPostOptions {
  * @param slug - Slug of the post to retrieve.
  * @public
  * @requiredField slug
- * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -4311,7 +4703,6 @@ interface GetPostBySlugOptions {
  * - `paging.limit` is `50`.
  * - `paging.offset` is `0`.
  * @public
- * @param options - Sort, filter, and paging options.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -4382,32 +4773,82 @@ interface ListPostsOptions {
     fieldsets?: PostFieldFieldWithLiterals[];
 }
 /**
- * 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` 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.
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
  *
- * `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.
+ * 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`.
  *
- * 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`.
+ * 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).
  * @public
- * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
  */
 declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
 interface QueryPostsOptions {
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    paging?: BlogPaging | undefined;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    filter?: Record<string, any> | null | undefined;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @internal
+     * @maxSize 3
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    sort?: Sorting[] | undefined;
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @maxSize 20
+     * @deprecated __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @replacedBy fieldsets
+     * @targetRemovalDate 2024-06-30
+     */
+    fieldsToInclude?: PostFieldFieldWithLiterals[] | undefined;
     /**
      * 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
@@ -4646,6 +5087,20 @@ type PostQuery = {
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
         /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
+        /**
       Origin point for geo-distance sorting on a GEO field
       results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
       */