@wix/auto_sdk_blog_posts 1.0.189 → 1.0.191

package/build/es/index.typings.d.mts

@@ -3618,172 +3618,6 @@ 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
@@ -3853,6 +3687,25 @@ 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;
@@ -3945,12 +3798,66 @@ 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;
@@ -4094,7 +4001,7 @@ interface ViewPostRequest {
     postId: string;
 }
 interface ViewPostResponse {
-    /** Total number of post views */
+    /** Updated total number of views for the post. */
     views?: number;
 }
 interface LikePostRequest {
@@ -4309,6 +4216,99 @@ 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 BaseEventMetadata {
     /**
      * App instance ID.
@@ -4456,13 +4456,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
@@ -4503,6 +4504,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
@@ -4523,12 +4525,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`, 4>>;
+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`, 5>>;
 interface GetPostOptions {
     /**
      * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4548,6 +4550,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
@@ -4575,6 +4578,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
@@ -4645,18 +4649,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
@@ -4927,7 +4939,9 @@ declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPos
 /**
  * Increments a post's view count.
  *
- * Call this method when a site visitor views a published post. The response returns the post's updated total number of views.
+ * Call this method when a site visitor views a published post. The post must already be published. The response returns the post's updated total number of views.
+ *
+ * This method accepts up to 100 calls per minute from an IP address on the site, and up to 100 calls per minute from an IP address for a single post. Further calls are rejected.
  * @param postId - Post ID.
  * @public
  * @requiredField postId