@wix/auto_sdk_blog_posts 1.0.150 → 1.0.151

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

@@ -508,7 +508,7 @@ type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
 interface Stop {
     /**
      * Stop color as hex value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Stop position (0-1). */
@@ -549,7 +549,7 @@ interface Background {
     type?: BackgroundTypeWithLiterals;
     /**
      * Background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Gradient configuration. */
@@ -656,33 +656,33 @@ interface Styles {
     borderRadius?: number | null;
     /**
      * Border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColor?: string | null;
     /**
      * Border color as a hexadecimal value (hover state).
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColorHover?: string | null;
     /**
      * Text color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     textColor?: string | null;
     /**
      * Text color as a hexadecimal value (hover state).
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     textColorHover?: string | null;
     /**
      * Deprecated: Use `background` instead.
-     * @format COLOR_HEX
+     * @maxLength 19
      * @deprecated
      */
     backgroundColor?: string | null;
     /**
      * Deprecated: Use `backgroundHover` instead.
-     * @format COLOR_HEX
+     * @maxLength 19
      * @deprecated
      */
     backgroundColorHover?: string | null;
@@ -1134,7 +1134,7 @@ interface StylesBorder {
     width?: number | null;
     /**
      * Border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Border radius in pixels. */
@@ -1175,22 +1175,22 @@ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HI
 interface LinkPreviewDataStyles {
     /**
      * Background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     backgroundColor?: string | null;
     /**
      * Title color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     titleColor?: string | null;
     /**
      * Subtitle color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     subtitleColor?: string | null;
     /**
      * Link color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     linkColor?: string | null;
     /** Border width in pixels. */
@@ -1199,7 +1199,7 @@ interface LinkPreviewDataStyles {
     borderRadius?: number | null;
     /**
      * Border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColor?: string | null;
     /** Position of thumbnail. Defaults to `START`. */
@@ -1350,19 +1350,19 @@ interface BackgroundGradient {
     angle?: number | null;
     /**
      * The start color as a hexademical value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     startColor?: string | null;
     /**
      * The end color as a hexademical value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     lastColor?: string | null;
 }
 interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
     /**
      * The background color as a hexademical value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** An image to use for the background. */
@@ -1376,7 +1376,7 @@ interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
 interface PollDesignBackgroundBackgroundOneOf {
     /**
      * The background color as a hexademical value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** An image to use for the background. */
@@ -1690,32 +1690,32 @@ interface ButtonStyles {
     borderRadius?: number | null;
     /**
      * Border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColor?: string | null;
     /**
      * Text color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     textColor?: string | null;
     /**
      * Background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     backgroundColor?: string | null;
     /**
      * Border color as a hexadecimal value (hover state).
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColorHover?: string | null;
     /**
      * Text color as a hexadecimal value (hover state).
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     textColorHover?: string | null;
     /**
      * Background color as a hexadecimal value (hover state).
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     backgroundColorHover?: string | null;
     /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
@@ -1732,7 +1732,7 @@ interface ImageStyles {
     resizing?: ResizingWithLiterals;
     /**
      * Image border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColor?: string | null;
     /** Image border width in pixels. */
@@ -1745,17 +1745,17 @@ interface RibbonStyles {
     ribbonText?: string | null;
     /**
      * Ribbon background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     backgroundColor?: string | null;
     /**
      * Ribbon text color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     textColor?: string | null;
     /**
      * Ribbon border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColor?: string | null;
     /** Ribbon border width in pixels. */
@@ -1768,12 +1768,12 @@ interface RibbonStyles {
 interface CardStyles {
     /**
      * Card background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     backgroundColor?: string | null;
     /**
      * Card border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColor?: string | null;
     /** Card border width in pixels. */
@@ -1788,12 +1788,12 @@ interface CardStyles {
     titlePriceLayout?: LayoutWithLiterals;
     /**
      * Title text color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     titleColor?: string | null;
     /**
      * Text color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     textColor?: string | null;
 }
@@ -1975,29 +1975,29 @@ interface CellStyle {
     verticalAlignment?: VerticalAlignmentWithLiterals;
     /**
      * Cell background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     backgroundColor?: string | null;
 }
 interface BorderColors {
     /**
      * Left border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     left?: string | null;
     /**
      * Right border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     right?: string | null;
     /**
      * Top border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     top?: string | null;
     /**
      * Bottom border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     bottom?: string | null;
 }
@@ -2072,7 +2072,7 @@ interface CaptionData {
 interface LayoutData {
     /**
      * Deprecated: Use `background` instead.
-     * @format COLOR_HEX
+     * @maxLength 19
      * @deprecated
      */
     backgroundColor?: string | null;
@@ -2080,7 +2080,7 @@ interface LayoutData {
     backgroundImage?: LayoutDataBackgroundImage;
     /**
      * Border color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     borderColor?: string | null;
     /** Border width in pixels. */
@@ -2089,7 +2089,7 @@ interface LayoutData {
     borderRadius?: number | null;
     /**
      * Deprecated: Use `backdrop` instead.
-     * @format COLOR_HEX
+     * @maxLength 19
      * @deprecated
      */
     backdropColor?: string | null;
@@ -2227,7 +2227,7 @@ interface LayoutDataBackground {
     type?: LayoutDataBackgroundTypeWithLiterals;
     /**
      * Background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Gradient configuration. */
@@ -2239,7 +2239,7 @@ interface Backdrop {
     type?: BackdropTypeWithLiterals;
     /**
      * Backdrop color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Gradient configuration. */
@@ -2260,7 +2260,7 @@ interface ShapeData {
 interface ShapeDataStyles {
     /**
      * Shape fill color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Map of original color keys to their new color values. */
@@ -2319,7 +2319,7 @@ interface CardDataBackground {
     type?: CardDataBackgroundTypeWithLiterals;
     /**
      * Background color as a hexadecimal value.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Gradient configuration. */
@@ -2346,7 +2346,7 @@ interface TocData {
     itemSpacing?: number | null;
     /**
      * Optional override for the text color.
-     * @format COLOR_HEX
+     * @maxLength 19
      */
     color?: string | null;
     /** Indentation style. Default: NESTED. */
@@ -2388,7 +2388,10 @@ interface SmartBlockData {
     orientation?: string | null;
     /** Column size controlling cells per row. */
     columnSize?: ColumnSizeWithLiterals;
-    /** Border color (for SOLID_JOINED_BOXES variant). */
+    /**
+     * Border color (for SOLID_JOINED_BOXES variant).
+     * @maxLength 19
+     */
     borderColor?: string | null;
     /** Border width in pixels (for SOLID_JOINED_BOXES variant). */
     borderWidth?: number | null;
@@ -2447,7 +2450,10 @@ interface SmartBlockCellData {
     label?: string | null;
     /** Shape file details. */
     shape?: V1Media;
-    /** Border color of the cell. */
+    /**
+     * Border color of the cell.
+     * @maxLength 19
+     */
     borderColor?: string | null;
     /** Border width in pixels. */
     borderWidth?: number | null;
@@ -2455,11 +2461,20 @@ interface SmartBlockCellData {
     borderRadius?: number | null;
     /** The type of the parent smart block (must match parent). */
     type?: SmartBlockDataTypeWithLiterals;
-    /** Accent color for non-background variants (e.g., line, bullet, label color). */
+    /**
+     * Accent color for non-background variants (e.g., line, bullet, label color).
+     * @maxLength 19
+     */
     accentColor?: string | null;
-    /** Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES). */
+    /**
+     * Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
+     * @maxLength 19
+     */
     backgroundColor?: string | null;
-    /** Shape fill color as a hexadecimal value. */
+    /**
+     * Shape fill color as a hexadecimal value.
+     * @maxLength 19
+     */
     shapeColor?: string | null;
 }
 interface Metadata {
@@ -4250,14 +4265,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
@@ -4298,7 +4312,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
@@ -4319,12 +4332,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
@@ -4344,7 +4357,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
@@ -4372,7 +4384,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
@@ -4443,26 +4454,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.
- *
- * The returned object contains the query definition which is typically used to run the query using the `find()` function.
- *
- * You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
  *
- * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
- * + `limit(50)`
- * + `descending('firstPublishedDate')`
- *
- * Note that the default limit is `'50'`, but the max limit is `'100'`.
- *
- * To learn how to query posts, refer to the table below.
+ * Query Posts runs with these defaults, which you can override:
+ * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
+ * - `paging.limit` is `50`.
+ * - `paging.offset` is `0`.
  *
- * The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
+ * To learn about working with _Query_ endpoints, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
+ * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
  * @public
- * @param options - Options specifying which fields to return.
  * @permissionId BLOG.READ-PUBLICATION
  * @applicableIdentity APP
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts

package/build/cjs/index.typings.js

@@ -1649,8 +1649,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,
@@ -1697,7 +1697,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)(
@@ -1756,7 +1756,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)(
@@ -1826,7 +1826,7 @@ function queryPosts2(options) {
             paths: [{ path: "posts.media.wixMedia.videoV2" }]
           }
         ]),
-        ["posts.richContent", "posts.rich_content"]
+        ["posts.richContent"]
       );
       return {
         items: transformedData?.posts,
@@ -1874,7 +1874,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)(