@wix/auto_sdk_blog_posts 1.0.163 → 1.0.164

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

@@ -2843,124 +2843,15 @@ interface PostUnlikedInitiatorOneOf {
      */
     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. */
-    rangeStart?: Date | null;
-    /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
-    rangeEnd?: Date | null;
-    /** Order of the returned results. */
-    order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
-    /** Number of months to include in the response. */
-    months?: number;
-    /**
-     * Language filter
-     *
-     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
-     * @format LANGUAGE_TAG
-     */
-    language?: string | null;
-    /**
-     * Timezone of the client.
-     * @minLength 3
-     * @maxLength 100
-     */
-    timeZone?: string | null;
-}
-declare enum QueryPublicationsCountStatsRequestOrder {
-    UNKNOWN = "UNKNOWN",
-    OLDEST = "OLDEST",
-    NEWEST = "NEWEST"
-}
-/** @enumType */
-type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
-/** Get Blog Publications Count Stats response */
-interface QueryPublicationsCountStatsResponse {
-    /** Chronologically ordered list of publications. */
-    stats?: PeriodPublicationsCount[];
-}
-/** Publications count for a specific time period */
-interface PeriodPublicationsCount {
-    /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
-    periodStart?: Date | null;
-    /** Number of posts published during this month. */
-    publicationsCount?: number;
-}
-/** Get Blog Post Count Stats request */
-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;
-    /**
-     * Order of returned results.
-     *
-     * - `OLDEST`: posts by date in ascending order.
-     * - `NEWEST`: posts by date in descending order.
-     *
-     * Default: `OLDEST`
-     */
-    order?: OrderWithLiterals;
-    /** Number of months to include in response. */
-    months?: number;
-    /**
-     * 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 the period post count for that specified language.
-     * @format LANGUAGE_TAG
-     */
-    language?: string | null;
-    /**
-     * Time zone to use when calculating the start of the month.
-     *
-     * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
-     * @minLength 3
-     * @maxLength 100
-     */
-    timeZone?: string | null;
-}
-declare enum Order {
-    UNKNOWN = "UNKNOWN",
-    OLDEST = "OLDEST",
-    NEWEST = "NEWEST"
-}
-/** @enumType */
-type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
-/** Get Blog Post Count Stats response */
-interface QueryPostCountStatsResponse {
-    /** List of published post counts by month. */
-    stats?: PeriodPostCount[];
-}
-/** Post count for a specific time period */
-interface PeriodPostCount {
-    /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
-    periodStart?: Date | null;
-    /** Number of posts published during this month. */
-    postCount?: number;
-}
-interface GetTotalPublicationsRequest {
-    /**
-     * Language filter
-     * @minLength 2
-     * @format LANGUAGE_TAG
-     */
-    language?: string | null;
-}
-interface GetTotalPublicationsResponse {
-    /** Total amount of publications. */
-    total?: number;
-}
-interface GetTotalPostsRequest {
+interface GetTotalLikesPerMemberRequest {
     /**
-     * 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 receive the total amount of posts in that specified language.
-     * @format LANGUAGE_TAG
+     * Member ID.
+     * @format GUID
      */
-    language?: string | null;
+    memberId?: string;
 }
-interface GetTotalPostsResponse {
-    /** Total amount of published posts. */
+interface GetTotalLikesPerMemberResponse {
+    /** The total number of likes of the member. */
     total?: number;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
@@ -3116,15 +3007,124 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
-interface GetTotalLikesPerMemberRequest {
+/** 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. */
+    rangeStart?: Date | null;
+    /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
+    rangeEnd?: Date | null;
+    /** Order of the returned results. */
+    order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
+    /** Number of months to include in the response. */
+    months?: number;
     /**
-     * Member ID.
-     * @format GUID
+     * Language filter
+     *
+     * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * @format LANGUAGE_TAG
      */
-    memberId?: string;
+    language?: string | null;
+    /**
+     * Timezone of the client.
+     * @minLength 3
+     * @maxLength 100
+     */
+    timeZone?: string | null;
 }
-interface GetTotalLikesPerMemberResponse {
-    /** The total number of likes of the member. */
+declare enum QueryPublicationsCountStatsRequestOrder {
+    UNKNOWN = "UNKNOWN",
+    OLDEST = "OLDEST",
+    NEWEST = "NEWEST"
+}
+/** @enumType */
+type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
+/** Get Blog Publications Count Stats response */
+interface QueryPublicationsCountStatsResponse {
+    /** Chronologically ordered list of publications. */
+    stats?: PeriodPublicationsCount[];
+}
+/** Publications count for a specific time period */
+interface PeriodPublicationsCount {
+    /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
+    periodStart?: Date | null;
+    /** Number of posts published during this month. */
+    publicationsCount?: number;
+}
+/** Get Blog Post Count Stats request */
+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;
+    /**
+     * Order of returned results.
+     *
+     * - `OLDEST`: posts by date in ascending order.
+     * - `NEWEST`: posts by date in descending order.
+     *
+     * Default: `OLDEST`
+     */
+    order?: OrderWithLiterals;
+    /** Number of months to include in response. */
+    months?: number;
+    /**
+     * 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 the period post count for that specified language.
+     * @format LANGUAGE_TAG
+     */
+    language?: string | null;
+    /**
+     * Time zone to use when calculating the start of the month.
+     *
+     * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
+     * @minLength 3
+     * @maxLength 100
+     */
+    timeZone?: string | null;
+}
+declare enum Order {
+    UNKNOWN = "UNKNOWN",
+    OLDEST = "OLDEST",
+    NEWEST = "NEWEST"
+}
+/** @enumType */
+type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
+/** Get Blog Post Count Stats response */
+interface QueryPostCountStatsResponse {
+    /** List of published post counts by month. */
+    stats?: PeriodPostCount[];
+}
+/** Post count for a specific time period */
+interface PeriodPostCount {
+    /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
+    periodStart?: Date | null;
+    /** Number of posts published during this month. */
+    postCount?: number;
+}
+interface GetTotalPublicationsRequest {
+    /**
+     * Language filter
+     * @minLength 2
+     * @format LANGUAGE_TAG
+     */
+    language?: string | null;
+}
+interface GetTotalPublicationsResponse {
+    /** Total amount of publications. */
+    total?: number;
+}
+interface GetTotalPostsRequest {
+    /**
+     * 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 receive the total amount of posts in that specified language.
+     * @format LANGUAGE_TAG
+     */
+    language?: string | null;
+}
+interface GetTotalPostsResponse {
+    /** Total amount of published posts. */
     total?: number;
 }
 interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
@@ -3972,14 +3972,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
@@ -4020,7 +4019,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
@@ -4041,12 +4039,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
@@ -4066,7 +4064,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
@@ -4094,7 +4091,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
@@ -4165,26 +4161,18 @@ 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.
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
  *
- * 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.
+ * 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

package/build/cjs/index.typings.js

@@ -1597,6 +1597,14 @@ var Status = /* @__PURE__ */ ((Status2) => {
   Status2["REJECTED"] = "REJECTED";
   return Status2;
 })(Status || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
 var QueryPublicationsCountStatsRequestOrder = /* @__PURE__ */ ((QueryPublicationsCountStatsRequestOrder2) => {
   QueryPublicationsCountStatsRequestOrder2["UNKNOWN"] = "UNKNOWN";
   QueryPublicationsCountStatsRequestOrder2["OLDEST"] = "OLDEST";
@@ -1609,14 +1617,6 @@ var Order = /* @__PURE__ */ ((Order2) => {
   Order2["NEWEST"] = "NEWEST";
   return Order2;
 })(Order || {});
-var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
-  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
-  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
-  WebhookIdentityType2["MEMBER"] = "MEMBER";
-  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
-  WebhookIdentityType2["APP"] = "APP";
-  return WebhookIdentityType2;
-})(WebhookIdentityType || {});
 var Field = /* @__PURE__ */ ((Field2) => {
   Field2["UNKNOWN"] = "UNKNOWN";
   Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
@@ -1744,8 +1744,8 @@ async function getPost2(postId, options) {
           paths: [{ path: "post.media.wixMedia.videoV2" }]
         }
       ]),
-      ["post.richContent", "post.rich_content"]
-    );
+      ["post.richContent"]
+    )?.post;
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
       err,
@@ -1792,7 +1792,7 @@ async function getPostBySlug2(slug, options) {
           paths: [{ path: "post.media.wixMedia.videoV2" }]
         }
       ]),
-      ["post.richContent", "post.rich_content"]
+      ["post.richContent"]
     );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
@@ -1851,7 +1851,7 @@ async function listPosts2(options) {
           paths: [{ path: "posts.media.wixMedia.videoV2" }]
         }
       ]),
-      ["posts.richContent", "posts.rich_content"]
+      ["posts.richContent"]
     );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
@@ -1921,7 +1921,7 @@ function queryPosts2(options) {
             paths: [{ path: "posts.media.wixMedia.videoV2" }]
           }
         ]),
-        ["posts.richContent", "posts.rich_content"]
+        ["posts.richContent"]
       );
       return {
         items: transformedData?.posts,
@@ -1969,7 +1969,7 @@ async function typedQueryPosts(query, options) {
           paths: [{ path: "posts.media.wixMedia.videoV2" }]
         }
       ]),
-      ["posts.richContent", "posts.rich_content"]
+      ["posts.richContent"]
     );
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(