@wix/auto_sdk_blog_posts 1.0.170 → 1.0.171

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

@@ -230,7 +230,15 @@ interface Tag {
     meta?: Record<string, any> | null;
     /** SEO tag inner content. For example, `<title> inner content </title>`. */
     children?: string;
-    /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
+    /**
+     * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
+     *
+     * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
+     * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
+     * or Wix Studio pages, so custom tags saved on those pages are missing from the response entirely. For
+     * those pages `false` therefore does not mean "not a custom tag" — it means this API could not tell.
+     * Pass `seoData` explicitly to resolve against a known set of tags.
+     */
     custom?: boolean;
     /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
     disabled?: boolean;
@@ -3401,6 +3409,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
@@ -3470,25 +3644,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;
@@ -3581,66 +3736,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;
@@ -3995,99 +4096,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 BaseEventMetadata {
     /**
      * App instance ID.

package/build/cjs/index.typings.js

@@ -1693,14 +1693,17 @@ var Order = /* @__PURE__ */ ((Order2) => {
   Order2["NEWEST"] = "NEWEST";
   return Order2;
 })(Order || {});
-var Field = /* @__PURE__ */ ((Field2) => {
-  Field2["UNKNOWN"] = "UNKNOWN";
-  Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
-  Field2["LIKE_COUNT"] = "LIKE_COUNT";
-  Field2["VIEW_COUNT"] = "VIEW_COUNT";
-  Field2["RATING_COUNT"] = "RATING_COUNT";
-  return Field2;
-})(Field || {});
+var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
+  GetPostsSort2["FEED"] = "FEED";
+  GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
+  GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
+  GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
+  GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
+  GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
+  GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
+  GetPostsSort2["RATING"] = "RATING";
+  return GetPostsSort2;
+})(GetPostsSort || {});
 var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
   PostFieldField2["UNKNOWN"] = "UNKNOWN";
   PostFieldField2["COUNTERS"] = "COUNTERS";
@@ -1724,17 +1727,14 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
   PostFieldField2["IMAGE"] = "IMAGE";
   return PostFieldField2;
 })(PostFieldField || {});
-var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
-  GetPostsSort2["FEED"] = "FEED";
-  GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
-  GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
-  GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
-  GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
-  GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
-  GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
-  GetPostsSort2["RATING"] = "RATING";
-  return GetPostsSort2;
-})(GetPostsSort || {});
+var Field = /* @__PURE__ */ ((Field2) => {
+  Field2["UNKNOWN"] = "UNKNOWN";
+  Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
+  Field2["LIKE_COUNT"] = "LIKE_COUNT";
+  Field2["VIEW_COUNT"] = "VIEW_COUNT";
+  Field2["RATING_COUNT"] = "RATING_COUNT";
+  return Field2;
+})(Field || {});
 var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
   SortOrder2["ASC"] = "ASC";
   SortOrder2["DESC"] = "DESC";