@wix/auto_sdk_blog_posts 1.0.181 → 1.0.182

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

@@ -3725,62 +3725,91 @@ interface GetTotalPostsResponse {
     /** Total amount of published posts. */
     total?: number;
 }
-interface ListDemoPostsRequest {
+interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
     /**
-     * Whether to return only featured posts.
-     *
-     * Default: `false`
+     * Member ID of person who triggered the counter update
+     * @format GUID
      */
-    featured?: boolean;
+    memberId?: string | null;
     /**
-     * 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
+     * Visitor ID if person that liked the post is not logged in
+     * @format GUID
      */
-    hashtags?: string[];
+    anonymousVisitorId?: string | null;
     /**
-     * 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
+     * ID of the post which counters were updated.
      * @format GUID
      */
-    categoryIds?: string[];
+    postId?: 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
+     * Internal ID of the post which counters were updated.
+     * @internal
+     * @maxLength 24
+     */
+    postInternalId?: string;
+    /** Field of the updated counter. */
+    updatedCounterField?: FieldWithLiterals;
+    /** New counter value. */
+    counter?: number;
+}
+/** @oneof */
+interface PostCountersUpdatedInitiatorOneOf {
+    /**
+     * Member ID of person who triggered the counter update
      * @format GUID
      */
-    tagIds?: string[];
+    memberId?: string | null;
     /**
-     * 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`
+     * Visitor ID if person that liked the post is not logged in
+     * @format GUID
      */
-    sort?: GetPostsSortWithLiterals;
-    /** Pagination options. */
-    paging?: BlogPaging;
+    anonymousVisitorId?: string | null;
+}
+declare enum Field {
+    /** Undefined field. */
+    UNKNOWN = "UNKNOWN",
+    /** Total comments field. */
+    TOTAL_COMMENTS = "TOTAL_COMMENTS",
+    /** Like count field. */
+    LIKE_COUNT = "LIKE_COUNT",
+    /** View count field. */
+    VIEW_COUNT = "VIEW_COUNT",
+    /** Rating count field. */
+    RATING_COUNT = "RATING_COUNT"
+}
+/** @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. */
+    count?: number;
+}
+interface GetPostRequest {
+    /**
+     * Post ID.
+     * @minLength 1
+     * @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.
@@ -3790,20 +3819,6 @@ interface ListDemoPostsRequest {
      * @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
@@ -3812,52 +3827,6 @@ interface ListDemoPostsRequest {
      */
     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",
-    /**
-     * 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';
-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",
     /**
@@ -3939,127 +3908,6 @@ declare enum PostFieldField {
 }
 /** @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
-     * @format GUID
-     */
-    memberId?: string | null;
-    /**
-     * Visitor ID if person that liked the post is not logged in
-     * @format GUID
-     */
-    anonymousVisitorId?: string | null;
-    /**
-     * ID of the post which counters were updated.
-     * @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. */
-    counter?: number;
-}
-/** @oneof */
-interface PostCountersUpdatedInitiatorOneOf {
-    /**
-     * Member ID of person who triggered the counter update
-     * @format GUID
-     */
-    memberId?: string | null;
-    /**
-     * Visitor ID if person that liked the post is not logged in
-     * @format GUID
-     */
-    anonymousVisitorId?: string | null;
-}
-declare enum Field {
-    /** Undefined field. */
-    UNKNOWN = "UNKNOWN",
-    /** Total comments field. */
-    TOTAL_COMMENTS = "TOTAL_COMMENTS",
-    /** Like count field. */
-    LIKE_COUNT = "LIKE_COUNT",
-    /** View count field. */
-    VIEW_COUNT = "VIEW_COUNT",
-    /** Rating count field. */
-    RATING_COUNT = "RATING_COUNT"
-}
-/** @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. */
-    count?: number;
-}
-interface GetPostRequest {
-    /**
-     * Post ID.
-     * @minLength 1
-     * @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
-     * only the post’s base fields are returned.
-     * @maxSize 20
-     */
-    fieldsets?: PostFieldFieldWithLiterals[];
-}
 interface GetPostResponse {
     /** Retrieved post info. */
     post?: Post;
@@ -4182,12 +4030,71 @@ 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",
+    /**
+     * 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';
+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 {
     /**
      * __Deprecated.__ Use `query` instead.
@@ -4639,6 +4546,99 @@ 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.