@wix/auto_sdk_blog_posts 1.0.54 → 1.0.56

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

@@ -169,6 +169,23 @@ interface Post {
      */
     referenceId?: string | null;
 }
+interface PostCountInfo {
+    /**
+     * Total number of post comments
+     * @readonly
+     */
+    comments?: number;
+    /**
+     * Total number of post likes
+     * @readonly
+     */
+    likes?: number;
+    /**
+     * Total number of post views
+     * @readonly
+     */
+    views?: number;
+}
 interface FocalPoint {
     /** X-coordinate of the focal point. */
     x?: number;
@@ -2030,6 +2047,66 @@ interface ScheduledPostPublished {
      */
     postId?: string;
 }
+interface PostLiked extends PostLikedInitiatorOneOf {
+    /**
+     * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Visitor ID of person who liked the post when they are not logged in.
+     * @format GUID
+     */
+    anonymousVisitorId?: string | null;
+    /**
+     * ID of the liked post.
+     * @format GUID
+     */
+    postId?: string;
+}
+/** @oneof */
+interface PostLikedInitiatorOneOf {
+    /**
+     * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Visitor ID of person who liked the post when they are not logged in.
+     * @format GUID
+     */
+    anonymousVisitorId?: string | null;
+}
+interface PostUnliked extends PostUnlikedInitiatorOneOf {
+    /**
+     * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Visitor ID of person who unliked the post when they are not logged in.
+     * @format GUID
+     */
+    anonymousVisitorId?: string | null;
+    /**
+     * ID of the unliked post.
+     * @format GUID
+     */
+    postId?: string;
+}
+/** @oneof */
+interface PostUnlikedInitiatorOneOf {
+    /**
+     * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Visitor ID of person who unliked the post when they are not logged in.
+     * @format GUID
+     */
+    anonymousVisitorId?: string | null;
+}
 /** Get Blog Publications Count Stats request */
 interface QueryPublicationsCountStatsRequest {
     /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
@@ -2731,66 +2808,6 @@ interface GetTotalLikesPerMemberResponse {
     /** The total number of likes of the member. */
     total?: number;
 }
-interface PostLiked extends PostLikedInitiatorOneOf {
-    /**
-     * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
-     * @format GUID
-     */
-    memberId?: string | null;
-    /**
-     * Visitor ID of person who liked the post when they are not logged in.
-     * @format GUID
-     */
-    anonymousVisitorId?: string | null;
-    /**
-     * ID of the liked post.
-     * @format GUID
-     */
-    postId?: string;
-}
-/** @oneof */
-interface PostLikedInitiatorOneOf {
-    /**
-     * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
-     * @format GUID
-     */
-    memberId?: string | null;
-    /**
-     * Visitor ID of person who liked the post when they are not logged in.
-     * @format GUID
-     */
-    anonymousVisitorId?: string | null;
-}
-interface PostUnliked extends PostUnlikedInitiatorOneOf {
-    /**
-     * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
-     * @format GUID
-     */
-    memberId?: string | null;
-    /**
-     * Visitor ID of person who unliked the post when they are not logged in.
-     * @format GUID
-     */
-    anonymousVisitorId?: string | null;
-    /**
-     * ID of the unliked post.
-     * @format GUID
-     */
-    postId?: string;
-}
-/** @oneof */
-interface PostUnlikedInitiatorOneOf {
-    /**
-     * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
-     * @format GUID
-     */
-    memberId?: string | null;
-    /**
-     * Visitor ID of person who unliked the post when they are not logged in.
-     * @format GUID
-     */
-    anonymousVisitorId?: string | null;
-}
 interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
     /**
      * Member ID of person who triggered the counter update
@@ -3415,23 +3432,6 @@ interface CoverMediaMediaOneOf {
     /** Video url. */
     video?: string;
 }
-interface PostCountInfo {
-    /**
-     * Total number of post comments
-     * @readonly
-     */
-    comments?: number;
-    /**
-     * Total number of post likes
-     * @readonly
-     */
-    likes?: number;
-    /**
-     * Total number of post views
-     * @readonly
-     */
-    views?: number;
-}
 interface OldBlogMigratedEvent {
     /**
      * Instance id of new version of blog
@@ -3496,13 +3496,11 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface PostCreatedEnvelope {
-    entity: Post;
+interface PostLikedEnvelope {
+    data: PostLiked;
     metadata: EventMetadata;
 }
-/**
- * Triggered when a post is created.
- * @permissionScope Read Blog
+/** @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
@@ -3512,18 +3510,15 @@ interface PostCreatedEnvelope {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @permissionId BLOG.READ-PUBLICATION
  * @webhook
- * @eventType wix.blog.v3.post_created
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
- * @slug created
+ * @eventType wix.blog.v3.post_liked
+ * @slug liked
  */
-declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise<void>): void;
-interface PostDeletedEnvelope {
-    entity: Post;
+declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise<void>): void;
+interface PostUnlikedEnvelope {
+    data: PostUnliked;
     metadata: EventMetadata;
 }
-/**
- * Triggered when a post is deleted.
- * @permissionScope Read Blog
+/** @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
@@ -3533,17 +3528,16 @@ interface PostDeletedEnvelope {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @permissionId BLOG.READ-PUBLICATION
  * @webhook
- * @eventType wix.blog.v3.post_deleted
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
- * @slug deleted
+ * @eventType wix.blog.v3.post_unliked
+ * @slug unliked
  */
-declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise<void>): void;
-interface PostLikedEnvelope {
-    data: PostLiked;
+declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise<void>): void;
+interface PostCreatedEnvelope {
+    entity: Post;
     metadata: EventMetadata;
 }
 /**
- * Triggered when a post is liked.
+ * Triggered when a post is created.
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
  * @permissionScope Manage Blog
@@ -3554,17 +3548,17 @@ interface PostLikedEnvelope {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @permissionId BLOG.READ-PUBLICATION
  * @webhook
- * @eventType wix.blog.v3.post_liked
+ * @eventType wix.blog.v3.post_created
  * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
- * @slug liked
+ * @slug created
  */
-declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise<void>): void;
-interface PostUnlikedEnvelope {
-    data: PostUnliked;
+declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise<void>): void;
+interface PostDeletedEnvelope {
+    entity: Post;
     metadata: EventMetadata;
 }
 /**
- * Triggered when a post is unliked.
+ * Triggered when a post is deleted.
  * @permissionScope Read Blog
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
  * @permissionScope Manage Blog
@@ -3575,11 +3569,11 @@ interface PostUnlikedEnvelope {
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
  * @permissionId BLOG.READ-PUBLICATION
  * @webhook
- * @eventType wix.blog.v3.post_unliked
+ * @eventType wix.blog.v3.post_deleted
  * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
- * @slug unliked
+ * @slug deleted
  */
-declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise<void>): void;
+declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise<void>): void;
 interface PostUpdatedEnvelope {
     entity: Post;
     metadata: EventMetadata;
@@ -3604,13 +3598,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
@@ -3651,6 +3646,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
@@ -3671,12 +3667,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` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `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.coverMedia.enabled` | `post.coverMedia.displayed` | `post.coverMedia.custom` | `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
@@ -3696,6 +3692,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
@@ -3723,6 +3720,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
@@ -3793,23 +3791,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`.
  *
- * 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).
+ * 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.
  *
- * 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).
+ * 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

package/build/cjs/index.typings.js

@@ -471,6 +471,9 @@ function queryPostCountStats(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl({
         protoPath: "/v2/stats/post/count",
         data: serializedData,
@@ -495,6 +498,9 @@ function getTotalPosts(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogBlogStatsServiceUrl({
         protoPath: "/v2/stats/posts/total",
         data: payload,
@@ -513,6 +519,9 @@ function getPost(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
         protoPath: "/v3/posts/{postId}",
         data: payload,
@@ -607,6 +616,9 @@ function getPostBySlug(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
         protoPath: "/v3/posts/slugs/{slug}",
         data: payload,
@@ -701,6 +713,9 @@ function listPosts(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
         protoPath: "/v3/posts",
         data: payload,
@@ -799,6 +814,9 @@ function queryPosts(payload) {
       method: "POST",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
         protoPath: "/v3/posts/query",
         data: payload,
@@ -897,6 +915,9 @@ function getPostMetrics(payload) {
       method: "GET",
       methodFqn: "com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressNpmCommunitiesPlatformizedBlogV3PostServiceUrl({
         protoPath: "/v3/posts/{postId}/metrics",
         data: payload,
@@ -1390,8 +1411,8 @@ async function getPost2(postId, options) {
           paths: [{ path: "post.media.wixMedia.videoV2" }]
         }
       ]),
-      ["post.richContent"]
-    )?.post;
+      ["post.richContent", "post.rich_content"]
+    );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
       err,
@@ -1443,7 +1464,7 @@ async function getPostBySlug2(slug, options) {
           paths: [{ path: "post.media.wixMedia.videoV2" }]
         }
       ]),
-      ["post.richContent"]
+      ["post.richContent", "post.rich_content"]
     );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
@@ -1507,7 +1528,7 @@ async function listPosts2(options) {
           paths: [{ path: "posts.media.wixMedia.videoV2" }]
         }
       ]),
-      ["posts.richContent"]
+      ["posts.richContent", "posts.rich_content"]
     );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
@@ -1582,7 +1603,7 @@ function queryPosts2(options) {
             paths: [{ path: "posts.media.wixMedia.videoV2" }]
           }
         ]),
-        ["posts.richContent"]
+        ["posts.richContent", "posts.rich_content"]
       );
       return {
         items: transformedData?.posts,