@wix/auto_sdk_blog_posts 1.0.167 → 1.0.168

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

@@ -65,6 +65,14 @@ interface Post {
     hashtags?: string[];
     /** Whether commenting on the post is enabled. */
     commentingEnabled?: boolean;
+    /**
+     * Dynamic post count info Comment Count, Like Count, View Count.
+     * @internal
+     * @deprecated Dynamic post count info Comment Count, Like Count, View Count.
+     * @replacedBy metrics
+     * @targetRemovalDate 2024-06-30
+     */
+    postCountInfo?: PostCountInfo;
     /** Estimated reading time (calculated automatically). */
     minutesToRead?: number;
     /** Image placed at the top of the blog page. Only displays on mobile devices. */
@@ -104,8 +112,22 @@ interface Post {
      * @format LANGUAGE_TAG
      */
     language?: string | null;
+    /**
+     * Post metrics.
+     * Deprecated on '2022-02-15', data can be inconsistent, for consistent data please use 'PostService#GetPostMetrics' API instead
+     * @internal
+     * @deprecated
+     */
+    metrics?: Metrics;
     /** SEO data. */
     seoData?: SeoSchema;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 400000
+     */
+    content?: string | null;
     /**
      * Contact ID of the post's owner. See the Contacts API for more info.
      * @format GUID
@@ -126,6 +148,19 @@ interface Post {
      * @readonly
      */
     preview?: boolean;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @maxLength 24
+     */
+    contentId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @format GUID
+     */
+    mostRecentContributorId?: string | null;
     /**
      * Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).
      *
@@ -142,17 +177,68 @@ interface Post {
      * @maxLength 8000000
      */
     richContentString?: string | null;
+    /**
+     * Post rich content as compressed binary data
+     * @internal
+     * @readonly
+     */
+    richContentCompressed?: Uint8Array | null;
     /**
      * Indicates if there is a draft post with changes that have not yet been published.
      * @readonly
      */
     hasUnpublishedChanges?: boolean;
+    /**
+     * List of the post's translated posts.
+     * @internal
+     * @readonly
+     * @maxSize 1000
+     */
+    translations?: PostTranslation[];
+    /**
+     * Identifies whether excerpt was set by contributor.
+     * True - excerpt was set by contributor.
+     * False - excerpt was generated from content.
+     * @internal
+     * @readonly
+     */
+    customExcerpt?: boolean;
     /**
      * Post reference ID. You can reference the post from other entities, for example, comments.
      * @readonly
      * @maxLength 24
      */
     referenceId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 24
+     */
+    internalId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxSize 10
+     * @maxLength 24
+     */
+    internalCategoryIds?: string[];
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxSize 3
+     * @maxLength 24
+     */
+    internalRelatedPostIds?: string[];
+    /**
+     * Identifies if post is created from template
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     */
+    isDemo?: boolean | null;
 }
 interface PostCountInfo {
     /**
@@ -197,6 +283,18 @@ interface Metrics {
      * @readonly
      */
     views?: number;
+    /**
+     * Total number of post ratings.
+     * @internal
+     * @readonly
+     */
+    totalRatings?: number;
+    /**
+     * Average rating of post from 1 to 5.
+     * @internal
+     * @readonly
+     */
+    averageRating?: number;
 }
 /**
  * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
@@ -2910,8 +3008,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: string;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 interface EmbedMedia {
     /** Thumbnail details. */
@@ -3282,6 +3440,20 @@ interface PeriodPublicationsCount {
 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;
+    /**
+     * __Deprecated.__ Use `months` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format.
+     * @internal
+     * @deprecated __Deprecated.__ Use `months` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format.
+     * @replacedBy months
+     * @targetRemovalDate 2024-06-30
+     */
+    rangeEnd?: Date | null;
     /**
      * Order of returned results.
      *
@@ -3371,6 +3543,12 @@ interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
      * @format GUID
      */
     postId?: string;
+    /**
+     * Internal ID of the post which counters were updated.
+     * @internal
+     * @maxLength 24
+     */
+    postInternalId?: string;
     /** Field of the updated counter. */
     updatedCounterField?: FieldWithLiterals;
     /** New counter value. */
@@ -3404,6 +3582,18 @@ declare enum Field {
 /** @enumType */
 type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
 interface PostOwnerChanged {
+    /**
+     * Member ID of the post's owner before the change.
+     * @internal
+     * @format GUID
+     */
+    oldMemberId?: string;
+    /**
+     * Member ID of the post's owner after the change.
+     * @internal
+     * @format GUID
+     */
+    newMemberId?: string;
 }
 interface InitialPostsCopied {
     /** Number of posts copied. */
@@ -3416,6 +3606,21 @@ interface GetPostRequest {
      * @maxLength 38
      */
     postId: string;
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @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[];
     /**
      * 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
@@ -3426,6 +3631,11 @@ interface GetPostRequest {
 }
 declare enum PostFieldField {
     UNKNOWN = "UNKNOWN",
+    /**
+     * Deprecated use `METRICS` instead.
+     * @internal
+     */
+    COUNTERS = "COUNTERS",
     /** Includes post URL when present. */
     URL = "URL",
     /** Includes post content text string when present. */
@@ -3434,12 +3644,69 @@ declare enum PostFieldField {
     METRICS = "METRICS",
     /** Includes SEO data. */
     SEO = "SEO",
+    /**
+     * Includes post content as a stringified DraftJS document.
+     * Reserved for internal use.
+     * @internal
+     */
+    CONTENT = "CONTENT",
+    /**
+     * Includes internal ID field.
+     * Reserved for internal use.
+     * @internal
+     */
+    INTERNAL_ID = "INTERNAL_ID",
     /** Includes post owner's contact ID. */
     CONTACT_ID = "CONTACT_ID",
     /** Includes post rich content. */
     RICH_CONTENT = "RICH_CONTENT",
+    /**
+     * Includes post rich content string.
+     * @internal
+     */
+    RICH_CONTENT_STRING = "RICH_CONTENT_STRING",
+    /**
+     * Includes compressed post rich content string.
+     * @internal
+     */
+    RICH_CONTENT_COMPRESSED = "RICH_CONTENT_COMPRESSED",
+    /**
+     * Includes post translations.
+     * @internal
+     */
+    TRANSLATIONS = "TRANSLATIONS",
     /** Includes post reference ID field. */
-    REFERENCE_ID = "REFERENCE_ID"
+    REFERENCE_ID = "REFERENCE_ID",
+    /**
+     * If provided, all content fields exclude paid content.
+     * @internal
+     */
+    EXCLUDE_PAID_CONTENT = "EXCLUDE_PAID_CONTENT",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    SEO_DATA = "SEO_DATA",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    OWNER = "OWNER",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    HAS_UNPUBLISHED_CHANGES = "HAS_UNPUBLISHED_CHANGES",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    HEADING = "HEADING",
+    /**
+     * Needed for post proxy to work correctly.
+     * @internal
+     */
+    IMAGE = "IMAGE"
 }
 /** @enumType */
 type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
@@ -3454,6 +3721,21 @@ interface GetPostBySlugRequest {
      * @maxLength 200
      */
     slug: string;
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @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[];
     /**
      * 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
@@ -3513,6 +3795,21 @@ interface ListPostsRequest {
     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.
+     * @internal
+     * @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.
      *
@@ -3549,7 +3846,12 @@ declare enum GetPostsSort {
     /** Ordered by `title` in ascending order. */
     TITLE_ASC = "TITLE_ASC",
     /** Ordered by `title` in descending order. */
-    TITLE_DESC = "TITLE_DESC"
+    TITLE_DESC = "TITLE_DESC",
+    /**
+     * Sorting by post rating descending.
+     * @internal
+     */
+    RATING = "RATING"
 }
 /** @enumType */
 type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
@@ -3596,6 +3898,64 @@ interface MetaData {
     cursor?: string | null;
 }
 interface QueryPostsRequest {
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    paging?: BlogPaging;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @internal
+     * @maxSize 3
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    sort?: Sorting[];
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @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[];
     /** Query options. */
     query?: PlatformQuery;
     /**
@@ -3614,6 +3974,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -3688,6 +4062,20 @@ interface CursorPaging {
 interface QueryPostsResponse {
     /** List of retrieved posts. */
     posts?: Post[];
+    /**
+     * __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @internal
+     * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
+     * This property will be removed on June 30, 2023.
+     *
+     * Details on the paged set of results returned.
+     * @replacedBy pagingMetadata
+     * @targetRemovalDate 2024-06-30
+     */
+    metaData?: MetaData;
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadataV2;
 }
@@ -3702,6 +4090,13 @@ interface PagingMetadataV2 {
     tooManyToCount?: boolean | null;
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     * @internal
+     */
+    hasNext?: boolean | null;
 }
 interface Cursors {
     /**
@@ -4408,6 +4803,64 @@ interface ListPostsOptions {
  */
 declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
 interface QueryPostsOptions {
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Pagination options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    paging?: BlogPaging | undefined;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @internal
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Filter object.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    filter?: Record<string, any> | null | undefined;
+    /**
+     * __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @internal
+     * @maxSize 3
+     * @deprecated __Deprecated.__ Use `query` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * Sorting options.
+     * @replacedBy query
+     * @targetRemovalDate 2024-06-30
+     */
+    sort?: Sorting[] | undefined;
+    /**
+     * __Deprecated.__ Use `fieldsets` instead.
+     * This parameter will be removed on June 30, 2023.
+     *
+     * List of post fields to be included in the response.
+     * @internal
+     * @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[] | undefined;
     /**
      * 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
@@ -4646,6 +5099,20 @@ type PostQuery = {
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
         /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
+        /**
       Origin point for geo-distance sorting on a GEO field
       results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
       */

package/build/internal/cjs/index.typings.js

@@ -1689,13 +1689,25 @@ var Field = /* @__PURE__ */ ((Field2) => {
 })(Field || {});
 var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
   PostFieldField2["UNKNOWN"] = "UNKNOWN";
+  PostFieldField2["COUNTERS"] = "COUNTERS";
   PostFieldField2["URL"] = "URL";
   PostFieldField2["CONTENT_TEXT"] = "CONTENT_TEXT";
   PostFieldField2["METRICS"] = "METRICS";
   PostFieldField2["SEO"] = "SEO";
+  PostFieldField2["CONTENT"] = "CONTENT";
+  PostFieldField2["INTERNAL_ID"] = "INTERNAL_ID";
   PostFieldField2["CONTACT_ID"] = "CONTACT_ID";
   PostFieldField2["RICH_CONTENT"] = "RICH_CONTENT";
+  PostFieldField2["RICH_CONTENT_STRING"] = "RICH_CONTENT_STRING";
+  PostFieldField2["RICH_CONTENT_COMPRESSED"] = "RICH_CONTENT_COMPRESSED";
+  PostFieldField2["TRANSLATIONS"] = "TRANSLATIONS";
   PostFieldField2["REFERENCE_ID"] = "REFERENCE_ID";
+  PostFieldField2["EXCLUDE_PAID_CONTENT"] = "EXCLUDE_PAID_CONTENT";
+  PostFieldField2["SEO_DATA"] = "SEO_DATA";
+  PostFieldField2["OWNER"] = "OWNER";
+  PostFieldField2["HAS_UNPUBLISHED_CHANGES"] = "HAS_UNPUBLISHED_CHANGES";
+  PostFieldField2["HEADING"] = "HEADING";
+  PostFieldField2["IMAGE"] = "IMAGE";
   return PostFieldField2;
 })(PostFieldField || {});
 var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
@@ -1706,6 +1718,7 @@ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
   GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
   GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
   GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
+  GetPostsSort2["RATING"] = "RATING";
   return GetPostsSort2;
 })(GetPostsSort || {});
 var SortOrder = /* @__PURE__ */ ((SortOrder2) => {