@wix/auto_sdk_blog_posts 1.0.164 → 1.0.165

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

@@ -782,7 +782,17 @@ interface DividerData {
     width?: WidthWithLiterals;
     /** Divider alignment. */
     alignment?: DividerDataAlignmentWithLiterals;
+    /** Visual styling for the divider lines. */
+    styles?: DividerDataStyles;
 }
+declare enum LineCap {
+    /** Square line endings. */
+    SQUARE = "SQUARE",
+    /** Rounded line endings. */
+    ROUND = "ROUND"
+}
+/** @enumType */
+type LineCapWithLiterals = LineCap | 'SQUARE' | 'ROUND';
 declare enum LineStyle {
     /** Single Line */
     SINGLE = "SINGLE",
@@ -815,6 +825,26 @@ declare enum DividerDataAlignment {
 }
 /** @enumType */
 type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
+interface DividerDataStyles {
+    /**
+     * Divider color as a hexadecimal value. An alpha channel controls opacity.
+     * @maxLength 19
+     */
+    color?: string | null;
+    /** Divider line ending shape. */
+    lineCap?: LineCapWithLiterals;
+    /**
+     * Line thicknesses in pixels, ordered from first line to last line.
+     * @maxSize 10
+     */
+    lineThickness?: number[];
+    /** Dash length in pixels for dashed dividers. */
+    dashLength?: number | null;
+    /** Gap between dashes or dots in pixels. */
+    dashGap?: number | null;
+    /** Gap between divider lines in pixels. */
+    lineGap?: number | null;
+}
 interface FileData {
     /** Styling for the file's container. */
     containerData?: PluginContainerData;
@@ -1139,6 +1169,8 @@ interface ImageData {
     styles?: ImageDataStyles;
     /** Non-destructive crop rectangle, expressed as fractions (0-1) of the original image. When omitted, the full image is shown. */
     crop?: ImageDataCrop;
+    /** Optional shape mask applied to the visible crop. Supported values: CIRCLE, OVAL, STAR, PENTAGON, HEXAGON, TRIANGLE, HEART, RHOMBUS, FLUID, WINDOW. */
+    cropShape?: string | null;
 }
 interface StylesBorder {
     /** Border width in pixels. */
@@ -3127,6 +3159,172 @@ interface GetTotalPostsResponse {
     /** Total amount of published posts. */
     total?: number;
 }
+interface ListDemoPostsRequest {
+    /**
+     * Whether to return only featured posts.
+     *
+     * Default: `false`
+     */
+    featured?: boolean;
+    /**
+     * Hashtag filter.
+     *
+     * 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[];
+    /**
+     * Category filter.
+     *
+     * 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
+     * @format GUID
+     */
+    categoryIds?: string[];
+    /**
+     * Tag filter.
+     *
+     * 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
+     * @format GUID
+     */
+    tagIds?: string[];
+    /**
+     * Sorting options.
+     *
+     * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
+     * - `VIEW_COUNT`: Ordered by total number of views in descending order.
+     * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
+     * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
+     * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
+     * - `TITLE_ASC`: Ordered by `title` in ascending order.
+     * - `TITLE_DESC`: Ordered by `title` in descending order.
+     * - `RATING`: reserved for internal use.
+     *
+     * Default: `FEED`
+     */
+    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.
+     * @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.
+     *
+     * 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;
+    /**
+     * Post owner's member ID.
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * 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?: PostFieldFieldWithLiterals[];
+}
+declare enum GetPostsSort {
+    /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
+    FEED = "FEED",
+    /** Ordered by `firstPublishedDate` in ascending order. */
+    PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
+    /** Ordered by `firstPublishedDate` in descending order. */
+    PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
+    /** Ordered by total number of views in descending order. */
+    VIEW_COUNT = "VIEW_COUNT",
+    /** Ordered by total number of likes in descending order. */
+    LIKE_COUNT = "LIKE_COUNT",
+    /** Ordered by `title` in ascending order. */
+    TITLE_ASC = "TITLE_ASC",
+    /** Ordered by `title` in descending order. */
+    TITLE_DESC = "TITLE_DESC"
+}
+/** @enumType */
+type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
+interface BlogPaging {
+    /**
+     * Number of items to skip in the current sort order.
+     *
+     *
+     * Default: `0`
+     */
+    offset?: number;
+    /**
+     * Number of items to return.
+     *
+     *
+     * Default:`50`
+     * @min 1
+     * @max 100
+     */
+    limit?: number;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * @maxLength 2000
+     */
+    cursor?: string | null;
+}
+declare enum PostFieldField {
+    UNKNOWN = "UNKNOWN",
+    /** Includes post URL when present. */
+    URL = "URL",
+    /** Includes post content text string when present. */
+    CONTENT_TEXT = "CONTENT_TEXT",
+    /** Includes post metrics when present. */
+    METRICS = "METRICS",
+    /** Includes SEO data. */
+    SEO = "SEO",
+    /** Includes post owner's contact ID. */
+    CONTACT_ID = "CONTACT_ID",
+    /** Includes post rich content. */
+    RICH_CONTENT = "RICH_CONTENT",
+    /** Includes post reference ID field. */
+    REFERENCE_ID = "REFERENCE_ID"
+}
+/** @enumType */
+type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
+interface ListDemoPostsResponse {
+    /** List of posts. */
+    posts?: Post[];
+    /** Details on the paged set of results returned. */
+    metaData?: MetaData;
+}
+interface MetaData {
+    /** Number of items returned in this response. */
+    count?: number;
+    /** Requested offset. */
+    offset?: number;
+    /** Total number of items that match the query. */
+    total?: number;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     * @maxLength 2000
+     */
+    cursor?: string | null;
+}
 interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
     /**
      * Member ID of person who triggered the counter update
@@ -3196,25 +3394,6 @@ interface GetPostRequest {
      */
     fieldsets?: PostFieldFieldWithLiterals[];
 }
-declare enum PostFieldField {
-    UNKNOWN = "UNKNOWN",
-    /** Includes post URL when present. */
-    URL = "URL",
-    /** Includes post content text string when present. */
-    CONTENT_TEXT = "CONTENT_TEXT",
-    /** Includes post metrics when present. */
-    METRICS = "METRICS",
-    /** Includes SEO data. */
-    SEO = "SEO",
-    /** Includes post owner's contact ID. */
-    CONTACT_ID = "CONTACT_ID",
-    /** Includes post rich content. */
-    RICH_CONTENT = "RICH_CONTENT",
-    /** Includes post reference ID field. */
-    REFERENCE_ID = "REFERENCE_ID"
-}
-/** @enumType */
-type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
 interface GetPostResponse {
     /** Retrieved post info. */
     post?: Post;
@@ -3307,66 +3486,12 @@ interface ListPostsRequest {
      */
     fieldsets?: PostFieldFieldWithLiterals[];
 }
-declare enum GetPostsSort {
-    /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
-    FEED = "FEED",
-    /** Ordered by `firstPublishedDate` in ascending order. */
-    PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
-    /** Ordered by `firstPublishedDate` in descending order. */
-    PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
-    /** Ordered by total number of views in descending order. */
-    VIEW_COUNT = "VIEW_COUNT",
-    /** Ordered by total number of likes in descending order. */
-    LIKE_COUNT = "LIKE_COUNT",
-    /** Ordered by `title` in ascending order. */
-    TITLE_ASC = "TITLE_ASC",
-    /** Ordered by `title` in descending order. */
-    TITLE_DESC = "TITLE_DESC"
-}
-/** @enumType */
-type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
-interface BlogPaging {
-    /**
-     * Number of items to skip in the current sort order.
-     *
-     *
-     * Default: `0`
-     */
-    offset?: number;
-    /**
-     * Number of items to return.
-     *
-     *
-     * Default:`50`
-     * @min 1
-     * @max 100
-     */
-    limit?: number;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     * @maxLength 2000
-     */
-    cursor?: string | null;
-}
 interface ListPostsResponse {
     /** List of retrieved posts. */
     posts?: Post[];
     /** Details on the paged set of results returned. */
     metaData?: MetaData;
 }
-interface MetaData {
-    /** Number of items returned in this response. */
-    count?: number;
-    /** Requested offset. */
-    offset?: number;
-    /** Total number of items that match the query. */
-    total?: number;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     * @maxLength 2000
-     */
-    cursor?: string | null;
-}
 interface QueryPostsRequest {
     /** Query options. */
     query?: PlatformQuery;
@@ -3386,6 +3511,11 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     */
+    origin?: AddressLocation;
 }
 declare enum SortOrder {
     ASC = "ASC",
@@ -3393,6 +3523,12 @@ declare enum SortOrder {
 }
 /** @enumType */
 type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
 interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
@@ -3710,121 +3846,6 @@ interface PostCount {
     /** Number of posts. */
     postCount?: number;
 }
-interface ListDemoPostsRequest {
-    /**
-     * Whether to return only featured posts.
-     *
-     * Default: `false`
-     */
-    featured?: boolean;
-    /**
-     * Hashtag filter.
-     *
-     * 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[];
-    /**
-     * Category filter.
-     *
-     * 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
-     * @format GUID
-     */
-    categoryIds?: string[];
-    /**
-     * Tag filter.
-     *
-     * 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
-     * @format GUID
-     */
-    tagIds?: string[];
-    /**
-     * Sorting options.
-     *
-     * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
-     * - `VIEW_COUNT`: Ordered by total number of views in descending order.
-     * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
-     * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
-     * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
-     * - `TITLE_ASC`: Ordered by `title` in ascending order.
-     * - `TITLE_DESC`: Ordered by `title` in descending order.
-     * - `RATING`: reserved for internal use.
-     *
-     * Default: `FEED`
-     */
-    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.
-     * @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.
-     *
-     * 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;
-    /**
-     * Post owner's member ID.
-     * @format GUID
-     */
-    memberId?: string | null;
-    /**
-     * 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?: PostFieldFieldWithLiterals[];
-}
-interface ListDemoPostsResponse {
-    /** List of posts. */
-    posts?: Post[];
-    /** Details on the paged set of results returned. */
-    metaData?: MetaData;
-}
-interface ConvertDraftJsToRichContentRequest {
-    /** DraftJs content to convert to Rich content. */
-    content?: Record<string, any> | null;
-}
-interface ConvertDraftJsToRichContentResponse {
-    /**
-     * Rich content converted from DraftJs content.
-     * @maxLength 2000000
-     */
-    richContent?: string;
-}
-interface ConvertRichContentToDraftJsRequest {
-    /**
-     * Rich content to convert to DraftJs content.
-     * @maxLength 2000000
-     */
-    richContent?: string;
-}
-interface ConvertRichContentToDraftJsResponse {
-    /** DraftJs content converted from Rich content. */
-    content?: Record<string, any> | null;
-}
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -3972,13 +3993,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
 /**
  * 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.
  * @public
+ * @param options - Options specifying time frame, sort, and filter.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
  * @returns Get Blog Post Count Stats response
@@ -4019,6 +4041,7 @@ 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
@@ -4039,12 +4062,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<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>>;
+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>>;
 interface GetPostOptions {
     /**
      * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4064,6 +4087,7 @@ 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
@@ -4091,6 +4115,7 @@ 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
@@ -4161,18 +4186,26 @@ interface ListPostsOptions {
     fieldsets?: PostFieldFieldWithLiterals[];
 }
 /**
- * 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`.
  *
- * 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).
+ * 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.
+ *
+ * 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`.
  * @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
@@ -4416,6 +4449,11 @@ type PostQuery = {
       Sort order.
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+        /**
+      Origin point for geo-distance sorting on a GEO field
+      results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+      */
+        origin?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['origin'];
     }[];
 };
 declare const utils: {
@@ -4438,4 +4476,4 @@ declare const utils: {
  */
 declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };