@wix/auto_sdk_blog_posts 1.0.151 → 1.0.153

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/build/cjs/index.d.ts +15 -11
  2. package/build/cjs/index.js +66 -49
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +666 -634
  5. package/build/cjs/index.typings.js +56 -44
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +536 -516
  8. package/build/cjs/meta.js +50 -38
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +86 -84
  11. package/build/cjs/schemas.js +153 -147
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +15 -11
  14. package/build/es/index.mjs +65 -49
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +666 -634
  17. package/build/es/index.typings.mjs +55 -44
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +536 -516
  20. package/build/es/meta.mjs +49 -38
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +86 -84
  23. package/build/es/schemas.mjs +153 -147
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +15 -11
  26. package/build/internal/cjs/index.js +66 -49
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +666 -634
  29. package/build/internal/cjs/index.typings.js +56 -44
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +536 -516
  32. package/build/internal/cjs/meta.js +50 -38
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +86 -84
  35. package/build/internal/cjs/schemas.js +153 -147
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +15 -11
  38. package/build/internal/es/index.mjs +65 -49
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +666 -634
  41. package/build/internal/es/index.typings.mjs +55 -44
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +536 -516
  44. package/build/internal/es/meta.mjs +49 -38
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +86 -84
  47. package/build/internal/es/schemas.mjs +153 -147
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -2116,7 +2116,7 @@ interface LayoutData {
2116
2116
  containerData?: PluginContainerData;
2117
2117
  /** Defines where selected design propertied applies to */
2118
2118
  designTarget?: DesignTargetWithLiterals;
2119
- /** Banner configuration. When present, this layout is displayed as a banner. */
2119
+ /** Banner configuration. When present, this layout is attached to a document edge (top or bottom). */
2120
2120
  banner?: Banner;
2121
2121
  /** Background styling (color or gradient). */
2122
2122
  background?: LayoutDataBackground;
@@ -2163,6 +2163,14 @@ declare enum BannerOrigin {
2163
2163
  }
2164
2164
  /** @enumType */
2165
2165
  type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
2166
+ declare enum BannerPosition {
2167
+ /** Attached to the top edge (banner) */
2168
+ TOP = "TOP",
2169
+ /** Attached to the bottom edge (footer) */
2170
+ BOTTOM = "BOTTOM"
2171
+ }
2172
+ /** @enumType */
2173
+ type BannerPositionWithLiterals = BannerPosition | 'TOP' | 'BOTTOM';
2166
2174
  /** Background type */
2167
2175
  declare enum LayoutDataBackgroundType {
2168
2176
  /** Solid color background */
@@ -2220,6 +2228,8 @@ type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
2220
2228
  interface Banner {
2221
2229
  /** Origin of the banner */
2222
2230
  origin?: BannerOriginWithLiterals;
2231
+ /** Position of the banner */
2232
+ position?: BannerPositionWithLiterals;
2223
2233
  }
2224
2234
  /** Background styling (color or gradient) */
2225
2235
  interface LayoutDataBackground {
@@ -2427,10 +2437,20 @@ declare enum SmartBlockDataType {
2427
2437
  /** Process steps with numbered/icon labels above a horizontal line. */
2428
2438
  PROCESS_STEPS = "PROCESS_STEPS",
2429
2439
  /** Statistics with bar visual elements. */
2430
- BAR_STATS = "BAR_STATS"
2440
+ BAR_STATS = "BAR_STATS",
2441
+ /** Timeline layout with numbered chips on a connecting line; cells alternate around the line. */
2442
+ TIMELINE = "TIMELINE",
2443
+ /** Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line. */
2444
+ MINIMAL_TIMELINE = "MINIMAL_TIMELINE",
2445
+ /** Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations. */
2446
+ PILLS = "PILLS",
2447
+ /** Star rating display with stars and a numeric value per cell. */
2448
+ STAR_RATING = "STAR_RATING",
2449
+ /** Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners. */
2450
+ QUOTE_BOXES = "QUOTE_BOXES"
2431
2451
  }
2432
2452
  /** @enumType */
2433
- type SmartBlockDataTypeWithLiterals = SmartBlockDataType | 'SOLID_BOXES' | 'NUMBERED_BOXES' | 'STATS' | 'CIRCLE_STATS' | 'SOLID_BOXES_ALTERNATING' | 'SOLID_JOINED_BOXES' | 'SIDE_LINE_TEXT' | 'TOP_LINE_TEXT' | 'OUTLINE_BOXES_WITH_TOP_CIRCLE' | 'BIG_BULLETS' | 'SMALL_BULLETS' | 'ARROW_BULLETS' | 'PROCESS_STEPS' | 'BAR_STATS';
2453
+ type SmartBlockDataTypeWithLiterals = SmartBlockDataType | 'SOLID_BOXES' | 'NUMBERED_BOXES' | 'STATS' | 'CIRCLE_STATS' | 'SOLID_BOXES_ALTERNATING' | 'SOLID_JOINED_BOXES' | 'SIDE_LINE_TEXT' | 'TOP_LINE_TEXT' | 'OUTLINE_BOXES_WITH_TOP_CIRCLE' | 'BIG_BULLETS' | 'SMALL_BULLETS' | 'ARROW_BULLETS' | 'PROCESS_STEPS' | 'BAR_STATS' | 'TIMELINE' | 'MINIMAL_TIMELINE' | 'PILLS' | 'STAR_RATING' | 'QUOTE_BOXES';
2434
2454
  /** Column size controlling how many cells appear per row. */
2435
2455
  declare enum ColumnSize {
2436
2456
  /** Up to 4 cells in a row. */
@@ -2744,598 +2764,314 @@ interface PostUnlikedInitiatorOneOf {
2744
2764
  */
2745
2765
  anonymousVisitorId?: string | null;
2746
2766
  }
2747
- interface GetTotalLikesPerMemberRequest {
2767
+ interface ListTemplatesRequest {
2748
2768
  /**
2749
- * Member ID.
2769
+ * Filter post templates by given template category ids
2770
+ * @maxSize 50
2750
2771
  * @format GUID
2751
2772
  */
2752
- memberId?: string;
2753
- }
2754
- interface GetTotalLikesPerMemberResponse {
2755
- /** The total number of likes of the member. */
2756
- total?: number;
2757
- }
2758
- interface DomainEvent extends DomainEventBodyOneOf {
2759
- createdEvent?: EntityCreatedEvent;
2760
- updatedEvent?: EntityUpdatedEvent;
2761
- deletedEvent?: EntityDeletedEvent;
2762
- actionEvent?: ActionEvent;
2763
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2764
- _id?: string;
2773
+ categoryIds?: string[];
2765
2774
  /**
2766
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2767
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2775
+ * Filter post templates by provided language
2776
+ * @format LANGUAGE_TAG
2768
2777
  */
2769
- entityFqdn?: string;
2778
+ language?: string | null;
2779
+ /** Returns post template categories when set to TRUE */
2780
+ listTemplateCategories?: boolean;
2781
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2782
+ sort?: GetPostTemplatesSortWithLiterals;
2783
+ /** Pagination options. */
2784
+ paging?: BlogPaging;
2785
+ }
2786
+ declare enum GetPostTemplatesSort {
2787
+ /** Sort by ascending publishing date. */
2788
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2789
+ /** Sort by descending publishing date. */
2790
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2791
+ }
2792
+ /** @enumType */
2793
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2794
+ interface BlogPaging {
2770
2795
  /**
2771
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2772
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2796
+ * Number of items to skip in the current sort order.
2797
+ *
2798
+ *
2799
+ * Default: `0`
2773
2800
  */
2774
- slug?: string;
2775
- /** ID of the entity associated with the event. */
2776
- entityId?: string;
2777
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2778
- eventTime?: Date | null;
2801
+ offset?: number;
2779
2802
  /**
2780
- * Whether the event was triggered as a result of a privacy regulation application
2781
- * (for example, GDPR).
2803
+ * Number of items to return.
2804
+ *
2805
+ *
2806
+ * Default:`50`
2807
+ * @min 1
2808
+ * @max 100
2782
2809
  */
2783
- triggeredByAnonymizeRequest?: boolean | null;
2784
- /** If present, indicates the action that triggered the event. */
2785
- originatedFrom?: string | null;
2810
+ limit?: number;
2786
2811
  /**
2787
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2788
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2812
+ * Pointer to the next or previous page in the list of results.
2813
+ * @maxLength 2000
2789
2814
  */
2790
- entityEventSequence?: string | null;
2791
- }
2792
- /** @oneof */
2793
- interface DomainEventBodyOneOf {
2794
- createdEvent?: EntityCreatedEvent;
2795
- updatedEvent?: EntityUpdatedEvent;
2796
- deletedEvent?: EntityDeletedEvent;
2797
- actionEvent?: ActionEvent;
2798
- }
2799
- interface EntityCreatedEvent {
2800
- entity?: string;
2815
+ cursor?: string | null;
2801
2816
  }
2802
- interface RestoreInfo {
2803
- deletedDate?: Date | null;
2817
+ interface ListTemplatesResponse {
2818
+ /** Available post templates */
2819
+ postTemplates?: Post[];
2820
+ /** Details on the paged set of posts templates returned. */
2821
+ postTemplatesMetaData?: MetaData;
2822
+ /** Post template categories. This value is returned empty unless asked explicitly */
2823
+ templateCategories?: Category[];
2804
2824
  }
2805
- interface EntityUpdatedEvent {
2825
+ interface MetaData {
2826
+ /** Number of items returned in this response. */
2827
+ count?: number;
2828
+ /** Requested offset. */
2829
+ offset?: number;
2830
+ /** Total number of items that match the query. */
2831
+ total?: number;
2806
2832
  /**
2807
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2808
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2809
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2833
+ * Pointer to the next or previous page in the list of results.
2834
+ * @maxLength 2000
2810
2835
  */
2811
- currentEntity?: string;
2812
- }
2813
- interface EntityDeletedEvent {
2814
- /** Entity that was deleted. */
2815
- deletedEntity?: string | null;
2816
- }
2817
- interface ActionEvent {
2818
- body?: string;
2836
+ cursor?: string | null;
2819
2837
  }
2820
- interface MessageEnvelope {
2838
+ interface Category {
2821
2839
  /**
2822
- * App instance ID.
2823
- * @format GUID
2840
+ * Category ID.
2841
+ * @immutable
2842
+ * @maxLength 38
2824
2843
  */
2825
- instanceId?: string | null;
2844
+ _id?: string;
2826
2845
  /**
2827
- * Event type.
2828
- * @maxLength 150
2846
+ * Category label. Displayed in the Category Menu.
2847
+ * @maxLength 35
2829
2848
  */
2830
- eventType?: string;
2831
- /** The identification type and identity data. */
2832
- identity?: IdentificationData;
2833
- /** Stringify payload. */
2834
- data?: string;
2835
- /** Details related to the account */
2836
- accountInfo?: AccountInfo;
2837
- }
2838
- interface IdentificationData extends IdentificationDataIdOneOf {
2849
+ label?: string;
2839
2850
  /**
2840
- * ID of a site visitor that has not logged in to the site.
2841
- * @format GUID
2851
+ * Number of posts in the category.
2852
+ * @readonly
2842
2853
  */
2843
- anonymousVisitorId?: string;
2854
+ postCount?: number;
2844
2855
  /**
2845
- * ID of a site visitor that has logged in to the site.
2846
- * @format GUID
2856
+ * The `url` of the page that lists every post with the specified category.
2857
+ * @readonly
2847
2858
  */
2848
- memberId?: string;
2859
+ url?: string;
2849
2860
  /**
2850
- * ID of a Wix user (site owner, contributor, etc.).
2851
- * @format GUID
2861
+ * Category description.
2862
+ * @maxLength 500
2852
2863
  */
2853
- wixUserId?: string;
2864
+ description?: string | null;
2854
2865
  /**
2855
- * ID of an app.
2856
- * @format GUID
2866
+ * Category title.
2867
+ * @maxLength 200
2868
+ * @deprecated Category title.
2869
+ * @targetRemovalDate 2025-07-16
2857
2870
  */
2858
- appId?: string;
2859
- /** @readonly */
2860
- identityType?: WebhookIdentityTypeWithLiterals;
2861
- }
2862
- /** @oneof */
2863
- interface IdentificationDataIdOneOf {
2871
+ title?: string;
2864
2872
  /**
2865
- * ID of a site visitor that has not logged in to the site.
2866
- * @format GUID
2873
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2874
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2875
+ *
2876
+ * Default: `-1`
2867
2877
  */
2868
- anonymousVisitorId?: string;
2878
+ displayPosition?: number | null;
2869
2879
  /**
2870
- * ID of a site visitor that has logged in to the site.
2880
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2871
2881
  * @format GUID
2872
2882
  */
2873
- memberId?: string;
2883
+ translationId?: string | null;
2874
2884
  /**
2875
- * ID of a Wix user (site owner, contributor, etc.).
2876
- * @format GUID
2885
+ * Category language.
2886
+ *
2887
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2888
+ * @immutable
2877
2889
  */
2878
- wixUserId?: string;
2890
+ language?: string | null;
2879
2891
  /**
2880
- * ID of an app.
2881
- * @format GUID
2892
+ * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
2893
+ * @maxLength 100
2882
2894
  */
2883
- appId?: string;
2884
- }
2885
- declare enum WebhookIdentityType {
2886
- UNKNOWN = "UNKNOWN",
2887
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2888
- MEMBER = "MEMBER",
2889
- WIX_USER = "WIX_USER",
2890
- APP = "APP"
2891
- }
2892
- /** @enumType */
2893
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2894
- interface AccountInfo {
2895
+ slug?: string;
2896
+ /** SEO data. */
2897
+ seoData?: SeoSchema;
2898
+ /** Category cover image. */
2899
+ coverImage?: string;
2895
2900
  /**
2896
- * ID of the Wix account associated with the event.
2897
- * @format GUID
2901
+ * Date and time the Category was last updated.
2902
+ * @readonly
2898
2903
  */
2899
- accountId?: string | null;
2904
+ _updatedDate?: Date | null;
2905
+ }
2906
+ interface CategoryTranslation {
2900
2907
  /**
2901
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2908
+ * Category ID.
2902
2909
  * @format GUID
2903
2910
  */
2904
- parentAccountId?: string | null;
2911
+ _id?: string;
2905
2912
  /**
2906
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2907
- * @format GUID
2913
+ * Label displayed in the categories menu on the site.
2914
+ * @maxLength 100
2908
2915
  */
2909
- siteId?: string | null;
2910
- }
2911
- /** Get Blog Publications Count Stats request */
2912
- interface QueryPublicationsCountStatsRequest {
2913
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2914
- rangeStart?: Date | null;
2915
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2916
- rangeEnd?: Date | null;
2917
- /** Order of the returned results. */
2918
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2919
- /** Number of months to include in the response. */
2920
- months?: number;
2916
+ label?: string | null;
2921
2917
  /**
2922
- * Language filter
2923
- *
2924
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2918
+ * Language of the category.
2925
2919
  * @format LANGUAGE_TAG
2926
2920
  */
2927
2921
  language?: string | null;
2922
+ /** URL of this category page. */
2923
+ url?: string;
2924
+ }
2925
+ interface GetTemplateRequest {
2928
2926
  /**
2929
- * Timezone of the client.
2930
- * @minLength 3
2931
- * @maxLength 100
2927
+ * Post template id
2928
+ * @format GUID
2932
2929
  */
2933
- timeZone?: string | null;
2930
+ postTemplateId?: string;
2934
2931
  }
2935
- declare enum QueryPublicationsCountStatsRequestOrder {
2936
- UNKNOWN = "UNKNOWN",
2937
- OLDEST = "OLDEST",
2938
- NEWEST = "NEWEST"
2932
+ interface GetTemplateResponse {
2933
+ /** Post template */
2934
+ postTemplate?: Post;
2939
2935
  }
2940
- /** @enumType */
2941
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2942
- /** Get Blog Publications Count Stats response */
2943
- interface QueryPublicationsCountStatsResponse {
2944
- /** Chronologically ordered list of publications. */
2945
- stats?: PeriodPublicationsCount[];
2936
+ interface CreateDraftPostFromTemplateRequest {
2937
+ /**
2938
+ * Post template id
2939
+ * @format GUID
2940
+ */
2941
+ postTemplateId?: string;
2946
2942
  }
2947
- /** Publications count for a specific time period */
2948
- interface PeriodPublicationsCount {
2949
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2950
- periodStart?: Date | null;
2951
- /** Number of posts published during this month. */
2952
- publicationsCount?: number;
2943
+ interface CreateDraftPostFromTemplateResponse {
2944
+ /** Created draft post */
2945
+ draftPost?: DraftPost;
2953
2946
  }
2954
- /** Get Blog Post Count Stats request */
2955
- interface QueryPostCountStatsRequest {
2956
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2957
- rangeStart?: Date | null;
2947
+ interface DraftPost {
2958
2948
  /**
2959
- * Order of returned results.
2960
- *
2961
- * - `OLDEST`: posts by date in ascending order.
2962
- * - `NEWEST`: posts by date in descending order.
2963
- *
2964
- * Default: `OLDEST`
2949
+ * Draft post ID.
2950
+ * @readonly
2951
+ * @maxLength 38
2965
2952
  */
2966
- order?: OrderWithLiterals;
2967
- /** Number of months to include in response. */
2968
- months?: number;
2953
+ _id?: string;
2969
2954
  /**
2970
- * Language filter.
2971
- *
2972
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2973
- * Pass a language to only receive the period post count for that specified language.
2974
- * @format LANGUAGE_TAG
2955
+ * Draft post title.
2956
+ * @maxLength 200
2975
2957
  */
2976
- language?: string | null;
2958
+ title?: string;
2977
2959
  /**
2978
- * Time zone to use when calculating the start of the month.
2960
+ * Draft post excerpt.
2979
2961
  *
2980
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2981
- * @minLength 3
2962
+ * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2963
+ * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2964
+ * @maxLength 500
2965
+ */
2966
+ excerpt?: string | null;
2967
+ /** Whether the draft post is marked as featured. */
2968
+ featured?: boolean | null;
2969
+ /**
2970
+ * Category IDs of the draft post.
2971
+ * @maxSize 10
2972
+ * @maxLength 38
2973
+ */
2974
+ categoryIds?: string[];
2975
+ /**
2976
+ * Draft post owner's member ID.
2977
+ * @format GUID
2978
+ */
2979
+ memberId?: string | null;
2980
+ /**
2981
+ * Hashtags in the post.
2982
+ * @maxSize 100
2982
2983
  * @maxLength 100
2983
2984
  */
2984
- timeZone?: string | null;
2985
- }
2986
- declare enum Order {
2987
- UNKNOWN = "UNKNOWN",
2988
- OLDEST = "OLDEST",
2989
- NEWEST = "NEWEST"
2990
- }
2991
- /** @enumType */
2992
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2993
- /** Get Blog Post Count Stats response */
2994
- interface QueryPostCountStatsResponse {
2995
- /** List of published post counts by month. */
2996
- stats?: PeriodPostCount[];
2997
- }
2998
- /** Post count for a specific time period */
2999
- interface PeriodPostCount {
3000
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3001
- periodStart?: Date | null;
3002
- /** Number of posts published during this month. */
3003
- postCount?: number;
3004
- }
3005
- interface GetTotalPublicationsRequest {
2985
+ hashtags?: string[];
2986
+ /** Whether commenting on the draft post is enabled. */
2987
+ commentingEnabled?: boolean | null;
3006
2988
  /**
3007
- * Language filter
3008
- * @minLength 2
3009
- * @format LANGUAGE_TAG
2989
+ * Estimated reading time of the draft post (calculated automatically).
2990
+ * @readonly
3010
2991
  */
3011
- language?: string | null;
3012
- }
3013
- interface GetTotalPublicationsResponse {
3014
- /** Total amount of publications. */
3015
- total?: number;
3016
- }
3017
- interface GetTotalPostsRequest {
2992
+ minutesToRead?: number;
2993
+ /** Image placed at the top of the blog page. */
2994
+ heroImage?: string;
3018
2995
  /**
3019
- * Language filter.
3020
- *
3021
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3022
- * Pass a language to receive the total amount of posts in that specified language.
3023
- * @format LANGUAGE_TAG
2996
+ * Tag IDs the draft post is tagged with.
2997
+ * @maxSize 30
2998
+ * @maxLength 38
3024
2999
  */
3025
- language?: string | null;
3026
- }
3027
- interface GetTotalPostsResponse {
3028
- /** Total amount of published posts. */
3029
- total?: number;
3030
- }
3031
- interface ListTemplatesRequest {
3000
+ tagIds?: string[];
3032
3001
  /**
3033
- * Filter post templates by given template category ids
3034
- * @maxSize 50
3035
- * @format GUID
3002
+ * IDs of posts related to this draft post.
3003
+ * @maxSize 3
3004
+ * @maxLength 38
3036
3005
  */
3037
- categoryIds?: string[];
3006
+ relatedPostIds?: string[];
3038
3007
  /**
3039
- * Filter post templates by provided language
3040
- * @format LANGUAGE_TAG
3008
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3009
+ * @maxSize 100
3010
+ * @format GUID
3041
3011
  */
3042
- language?: string | null;
3043
- /** Returns post template categories when set to TRUE */
3044
- listTemplateCategories?: boolean;
3045
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
3046
- sort?: GetPostTemplatesSortWithLiterals;
3047
- /** Pagination options. */
3048
- paging?: BlogPaging;
3049
- }
3050
- declare enum GetPostTemplatesSort {
3051
- /** Sort by ascending publishing date. */
3052
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3053
- /** Sort by descending publishing date. */
3054
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
3055
- }
3056
- /** @enumType */
3057
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
3058
- interface BlogPaging {
3012
+ pricingPlanIds?: string[];
3059
3013
  /**
3060
- * Number of items to skip in the current sort order.
3061
- *
3014
+ * ID of the draft post's translations.
3062
3015
  *
3063
- * Default: `0`
3016
+ * All translations of a single post share the same `translationId`.
3017
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3018
+ * @format GUID
3064
3019
  */
3065
- offset?: number;
3020
+ translationId?: string | null;
3066
3021
  /**
3067
- * Number of items to return.
3068
- *
3022
+ * Language the draft post is written in.
3069
3023
  *
3070
- * Default:`50`
3071
- * @min 1
3072
- * @max 100
3024
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3025
+ * @format LANGUAGE_TAG
3073
3026
  */
3074
- limit?: number;
3027
+ language?: string | null;
3075
3028
  /**
3076
- * Pointer to the next or previous page in the list of results.
3077
- * @maxLength 2000
3029
+ * Draft Post rich content.
3030
+ *
3031
+ * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
3032
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3033
+ * </widget>
3078
3034
  */
3079
- cursor?: string | null;
3080
- }
3081
- interface ListTemplatesResponse {
3082
- /** Available post templates */
3083
- postTemplates?: Post[];
3084
- /** Details on the paged set of posts templates returned. */
3085
- postTemplatesMetaData?: MetaData;
3086
- /** Post template categories. This value is returned empty unless asked explicitly */
3087
- templateCategories?: Category[];
3088
- }
3089
- interface MetaData {
3090
- /** Number of items returned in this response. */
3091
- count?: number;
3092
- /** Requested offset. */
3093
- offset?: number;
3094
- /** Total number of items that match the query. */
3095
- total?: number;
3035
+ richContent?: RichContent;
3096
3036
  /**
3097
- * Pointer to the next or previous page in the list of results.
3098
- * @maxLength 2000
3037
+ * Status of the draft post.
3038
+ * @readonly
3099
3039
  */
3100
- cursor?: string | null;
3101
- }
3102
- interface Category {
3040
+ status?: StatusWithLiterals;
3041
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3042
+ moderationDetails?: ModerationDetails;
3103
3043
  /**
3104
- * Category ID.
3105
- * @immutable
3106
- * @maxLength 38
3044
+ * Indicates if there are changes made to the draft post that have not yet been published.
3045
+ * @readonly
3107
3046
  */
3108
- _id?: string;
3047
+ hasUnpublishedChanges?: boolean;
3109
3048
  /**
3110
- * Category label. Displayed in the Category Menu.
3111
- * @maxLength 35
3049
+ * Date the draft post was last edited.
3050
+ * @readonly
3112
3051
  */
3113
- label?: string;
3052
+ editedDate?: Date | null;
3114
3053
  /**
3115
- * Number of posts in the category.
3054
+ * Date the draft post is scheduled to be published.
3116
3055
  * @readonly
3117
3056
  */
3118
- postCount?: number;
3057
+ scheduledPublishDate?: Date | null;
3058
+ /** Date the post was first published. */
3059
+ firstPublishedDate?: Date | null;
3060
+ /** SEO data. */
3061
+ seoData?: SeoSchema;
3119
3062
  /**
3120
- * The `url` of the page that lists every post with the specified category.
3063
+ * Draft post URL preview. What the URL will look like once the post is published.
3121
3064
  * @readonly
3122
3065
  */
3123
3066
  url?: string;
3124
3067
  /**
3125
- * Category description.
3126
- * @maxLength 500
3068
+ * Date the draft post was first created.
3069
+ * @readonly
3127
3070
  */
3128
- description?: string | null;
3071
+ _createdDate?: Date | null;
3129
3072
  /**
3130
- * Category title.
3131
- * @maxLength 200
3132
- * @deprecated Category title.
3133
- * @targetRemovalDate 2025-07-16
3134
- */
3135
- title?: string;
3136
- /**
3137
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
3138
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
3139
- *
3140
- * Default: `-1`
3141
- */
3142
- displayPosition?: number | null;
3143
- /**
3144
- * ID of the category's translations. All translations of a single category share the same `translationId`.
3145
- * @format GUID
3146
- */
3147
- translationId?: string | null;
3148
- /**
3149
- * Category language.
3150
- *
3151
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3152
- * @immutable
3153
- */
3154
- language?: string | null;
3155
- /**
3156
- * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
3157
- * @maxLength 100
3158
- */
3159
- slug?: string;
3160
- /** SEO data. */
3161
- seoData?: SeoSchema;
3162
- /** Category cover image. */
3163
- coverImage?: string;
3164
- /**
3165
- * Date and time the Category was last updated.
3166
- * @readonly
3167
- */
3168
- _updatedDate?: Date | null;
3169
- }
3170
- interface CategoryTranslation {
3171
- /**
3172
- * Category ID.
3173
- * @format GUID
3174
- */
3175
- _id?: string;
3176
- /**
3177
- * Label displayed in the categories menu on the site.
3178
- * @maxLength 100
3179
- */
3180
- label?: string | null;
3181
- /**
3182
- * Language of the category.
3183
- * @format LANGUAGE_TAG
3184
- */
3185
- language?: string | null;
3186
- /** URL of this category page. */
3187
- url?: string;
3188
- }
3189
- interface GetTemplateRequest {
3190
- /**
3191
- * Post template id
3192
- * @format GUID
3193
- */
3194
- postTemplateId?: string;
3195
- }
3196
- interface GetTemplateResponse {
3197
- /** Post template */
3198
- postTemplate?: Post;
3199
- }
3200
- interface CreateDraftPostFromTemplateRequest {
3201
- /**
3202
- * Post template id
3203
- * @format GUID
3204
- */
3205
- postTemplateId?: string;
3206
- }
3207
- interface CreateDraftPostFromTemplateResponse {
3208
- /** Created draft post */
3209
- draftPost?: DraftPost;
3210
- }
3211
- interface DraftPost {
3212
- /**
3213
- * Draft post ID.
3214
- * @readonly
3215
- * @maxLength 38
3216
- */
3217
- _id?: string;
3218
- /**
3219
- * Draft post title.
3220
- * @maxLength 200
3221
- */
3222
- title?: string;
3223
- /**
3224
- * Draft post excerpt.
3225
- *
3226
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3227
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3228
- * @maxLength 500
3229
- */
3230
- excerpt?: string | null;
3231
- /** Whether the draft post is marked as featured. */
3232
- featured?: boolean | null;
3233
- /**
3234
- * Category IDs of the draft post.
3235
- * @maxSize 10
3236
- * @maxLength 38
3237
- */
3238
- categoryIds?: string[];
3239
- /**
3240
- * Draft post owner's member ID.
3241
- * @format GUID
3242
- */
3243
- memberId?: string | null;
3244
- /**
3245
- * Hashtags in the post.
3246
- * @maxSize 100
3247
- * @maxLength 100
3248
- */
3249
- hashtags?: string[];
3250
- /** Whether commenting on the draft post is enabled. */
3251
- commentingEnabled?: boolean | null;
3252
- /**
3253
- * Estimated reading time of the draft post (calculated automatically).
3254
- * @readonly
3255
- */
3256
- minutesToRead?: number;
3257
- /** Image placed at the top of the blog page. */
3258
- heroImage?: string;
3259
- /**
3260
- * Tag IDs the draft post is tagged with.
3261
- * @maxSize 30
3262
- * @maxLength 38
3263
- */
3264
- tagIds?: string[];
3265
- /**
3266
- * IDs of posts related to this draft post.
3267
- * @maxSize 3
3268
- * @maxLength 38
3269
- */
3270
- relatedPostIds?: string[];
3271
- /**
3272
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3273
- * @maxSize 100
3274
- * @format GUID
3275
- */
3276
- pricingPlanIds?: string[];
3277
- /**
3278
- * ID of the draft post's translations.
3279
- *
3280
- * All translations of a single post share the same `translationId`.
3281
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3282
- * @format GUID
3283
- */
3284
- translationId?: string | null;
3285
- /**
3286
- * Language the draft post is written in.
3287
- *
3288
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3289
- * @format LANGUAGE_TAG
3290
- */
3291
- language?: string | null;
3292
- /**
3293
- * Draft Post rich content.
3294
- *
3295
- * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
3296
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3297
- * </widget>
3298
- */
3299
- richContent?: RichContent;
3300
- /**
3301
- * Status of the draft post.
3302
- * @readonly
3303
- */
3304
- status?: StatusWithLiterals;
3305
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3306
- moderationDetails?: ModerationDetails;
3307
- /**
3308
- * Indicates if there are changes made to the draft post that have not yet been published.
3309
- * @readonly
3310
- */
3311
- hasUnpublishedChanges?: boolean;
3312
- /**
3313
- * Date the draft post was last edited.
3314
- * @readonly
3315
- */
3316
- editedDate?: Date | null;
3317
- /**
3318
- * Date the draft post is scheduled to be published.
3319
- * @readonly
3320
- */
3321
- scheduledPublishDate?: Date | null;
3322
- /** Date the post was first published. */
3323
- firstPublishedDate?: Date | null;
3324
- /** SEO data. */
3325
- seoData?: SeoSchema;
3326
- /**
3327
- * Draft post URL preview. What the URL will look like once the post is published.
3328
- * @readonly
3329
- */
3330
- url?: string;
3331
- /**
3332
- * Date the draft post was first created.
3333
- * @readonly
3334
- */
3335
- _createdDate?: Date | null;
3336
- /**
3337
- * SEO slug.
3338
- * @maxLength 100
3073
+ * SEO slug.
3074
+ * @maxLength 100
3339
3075
  */
3340
3076
  seoSlug?: string | null;
3341
3077
  /** Post cover media. */
@@ -3456,157 +3192,289 @@ interface DraftPostTranslation {
3456
3192
  /** Post URL. */
3457
3193
  url?: string;
3458
3194
  }
3459
- interface ListDemoPostsRequest {
3195
+ interface DomainEvent extends DomainEventBodyOneOf {
3196
+ createdEvent?: EntityCreatedEvent;
3197
+ updatedEvent?: EntityUpdatedEvent;
3198
+ deletedEvent?: EntityDeletedEvent;
3199
+ actionEvent?: ActionEvent;
3200
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3201
+ _id?: string;
3460
3202
  /**
3461
- * Whether to return only featured posts.
3462
- *
3463
- * Default: `false`
3203
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3204
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3464
3205
  */
3465
- featured?: boolean;
3206
+ entityFqdn?: string;
3466
3207
  /**
3467
- * Hashtag filter.
3468
- *
3469
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3470
- * If omitted, all posts with or without hashtags are returned.
3471
- * @maxSize 100
3472
- * @maxLength 100
3208
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3209
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3473
3210
  */
3474
- hashtags?: string[];
3211
+ slug?: string;
3212
+ /** ID of the entity associated with the event. */
3213
+ entityId?: string;
3214
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3215
+ eventTime?: Date | null;
3475
3216
  /**
3476
- * Category filter.
3477
- *
3478
- * Pass an array of category IDs to return only posts with any of the provided categories.
3479
- * If omitted, all posts with or without associated categories are returned.
3480
- * @maxSize 50
3217
+ * Whether the event was triggered as a result of a privacy regulation application
3218
+ * (for example, GDPR).
3219
+ */
3220
+ triggeredByAnonymizeRequest?: boolean | null;
3221
+ /** If present, indicates the action that triggered the event. */
3222
+ originatedFrom?: string | null;
3223
+ /**
3224
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
3225
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
3226
+ */
3227
+ entityEventSequence?: string | null;
3228
+ }
3229
+ /** @oneof */
3230
+ interface DomainEventBodyOneOf {
3231
+ createdEvent?: EntityCreatedEvent;
3232
+ updatedEvent?: EntityUpdatedEvent;
3233
+ deletedEvent?: EntityDeletedEvent;
3234
+ actionEvent?: ActionEvent;
3235
+ }
3236
+ interface EntityCreatedEvent {
3237
+ entity?: string;
3238
+ }
3239
+ interface RestoreInfo {
3240
+ deletedDate?: Date | null;
3241
+ }
3242
+ interface EntityUpdatedEvent {
3243
+ /**
3244
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3245
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3246
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3247
+ */
3248
+ currentEntity?: string;
3249
+ }
3250
+ interface EntityDeletedEvent {
3251
+ /** Entity that was deleted. */
3252
+ deletedEntity?: string | null;
3253
+ }
3254
+ interface ActionEvent {
3255
+ body?: string;
3256
+ }
3257
+ interface MessageEnvelope {
3258
+ /**
3259
+ * App instance ID.
3481
3260
  * @format GUID
3482
3261
  */
3483
- categoryIds?: string[];
3262
+ instanceId?: string | null;
3484
3263
  /**
3485
- * Tag filter.
3486
- *
3487
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3488
- * If omitted, all posts with or without tags are returned.
3489
- * @maxSize 50
3264
+ * Event type.
3265
+ * @maxLength 150
3266
+ */
3267
+ eventType?: string;
3268
+ /** The identification type and identity data. */
3269
+ identity?: IdentificationData;
3270
+ /** Stringify payload. */
3271
+ data?: string;
3272
+ /** Details related to the account */
3273
+ accountInfo?: AccountInfo;
3274
+ }
3275
+ interface IdentificationData extends IdentificationDataIdOneOf {
3276
+ /**
3277
+ * ID of a site visitor that has not logged in to the site.
3490
3278
  * @format GUID
3491
3279
  */
3492
- tagIds?: string[];
3280
+ anonymousVisitorId?: string;
3493
3281
  /**
3494
- * Sorting options.
3495
- *
3496
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3497
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3498
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3499
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3500
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3501
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3502
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3503
- * - `RATING`: reserved for internal use.
3504
- *
3505
- * Default: `FEED`
3282
+ * ID of a site visitor that has logged in to the site.
3283
+ * @format GUID
3506
3284
  */
3507
- sort?: GetPostsSortWithLiterals;
3508
- /** Pagination options. */
3509
- paging?: BlogPaging;
3285
+ memberId?: string;
3510
3286
  /**
3511
- * __Deprecated.__ Use `fieldsets` instead.
3512
- * This parameter will be removed on June 30, 2023.
3513
- *
3514
- * List of post fields to be included in the response.
3515
- * @maxSize 20
3516
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
3517
- * This parameter will be removed on June 30, 2023.
3518
- *
3519
- * List of post fields to be included in the response.
3520
- * @replacedBy fieldsets
3521
- * @targetRemovalDate 2024-06-30
3287
+ * ID of a Wix user (site owner, contributor, etc.).
3288
+ * @format GUID
3522
3289
  */
3523
- fieldsToInclude?: PostFieldFieldWithLiterals[];
3290
+ wixUserId?: string;
3524
3291
  /**
3525
- * Language filter.
3292
+ * ID of an app.
3293
+ * @format GUID
3294
+ */
3295
+ appId?: string;
3296
+ /** @readonly */
3297
+ identityType?: WebhookIdentityTypeWithLiterals;
3298
+ }
3299
+ /** @oneof */
3300
+ interface IdentificationDataIdOneOf {
3301
+ /**
3302
+ * ID of a site visitor that has not logged in to the site.
3303
+ * @format GUID
3304
+ */
3305
+ anonymousVisitorId?: string;
3306
+ /**
3307
+ * ID of a site visitor that has logged in to the site.
3308
+ * @format GUID
3309
+ */
3310
+ memberId?: string;
3311
+ /**
3312
+ * ID of a Wix user (site owner, contributor, etc.).
3313
+ * @format GUID
3314
+ */
3315
+ wixUserId?: string;
3316
+ /**
3317
+ * ID of an app.
3318
+ * @format GUID
3319
+ */
3320
+ appId?: string;
3321
+ }
3322
+ declare enum WebhookIdentityType {
3323
+ UNKNOWN = "UNKNOWN",
3324
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3325
+ MEMBER = "MEMBER",
3326
+ WIX_USER = "WIX_USER",
3327
+ APP = "APP"
3328
+ }
3329
+ /** @enumType */
3330
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3331
+ interface AccountInfo {
3332
+ /**
3333
+ * ID of the Wix account associated with the event.
3334
+ * @format GUID
3335
+ */
3336
+ accountId?: string | null;
3337
+ /**
3338
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
3339
+ * @format GUID
3340
+ */
3341
+ parentAccountId?: string | null;
3342
+ /**
3343
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3344
+ * @format GUID
3345
+ */
3346
+ siteId?: string | null;
3347
+ }
3348
+ /** Get Blog Publications Count Stats request */
3349
+ interface QueryPublicationsCountStatsRequest {
3350
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3351
+ rangeStart?: Date | null;
3352
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3353
+ rangeEnd?: Date | null;
3354
+ /** Order of the returned results. */
3355
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3356
+ /** Number of months to include in the response. */
3357
+ months?: number;
3358
+ /**
3359
+ * Language filter
3526
3360
  *
3527
3361
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3528
- * Pass a language to only receive posts that are in that language.
3529
- * If omitted, posts in all languages are returned.
3530
3362
  * @format LANGUAGE_TAG
3531
3363
  */
3532
3364
  language?: string | null;
3533
3365
  /**
3534
- * Post owner's member ID.
3535
- * @format GUID
3366
+ * Timezone of the client.
3367
+ * @minLength 3
3368
+ * @maxLength 100
3536
3369
  */
3537
- memberId?: string | null;
3370
+ timeZone?: string | null;
3371
+ }
3372
+ declare enum QueryPublicationsCountStatsRequestOrder {
3373
+ UNKNOWN = "UNKNOWN",
3374
+ OLDEST = "OLDEST",
3375
+ NEWEST = "NEWEST"
3376
+ }
3377
+ /** @enumType */
3378
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3379
+ /** Get Blog Publications Count Stats response */
3380
+ interface QueryPublicationsCountStatsResponse {
3381
+ /** Chronologically ordered list of publications. */
3382
+ stats?: PeriodPublicationsCount[];
3383
+ }
3384
+ /** Publications count for a specific time period */
3385
+ interface PeriodPublicationsCount {
3386
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3387
+ periodStart?: Date | null;
3388
+ /** Number of posts published during this month. */
3389
+ publicationsCount?: number;
3390
+ }
3391
+ /** Get Blog Post Count Stats request */
3392
+ interface QueryPostCountStatsRequest {
3393
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3394
+ rangeStart?: Date | null;
3538
3395
  /**
3539
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3540
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3541
- * only the post’s base fields are returned.
3542
- * @maxSize 20
3396
+ * Order of returned results.
3397
+ *
3398
+ * - `OLDEST`: posts by date in ascending order.
3399
+ * - `NEWEST`: posts by date in descending order.
3400
+ *
3401
+ * Default: `OLDEST`
3543
3402
  */
3544
- fieldsets?: PostFieldFieldWithLiterals[];
3545
- }
3546
- declare enum GetPostsSort {
3547
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3548
- FEED = "FEED",
3549
- /** Ordered by `firstPublishedDate` in ascending order. */
3550
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3551
- /** Ordered by `firstPublishedDate` in descending order. */
3552
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3553
- /** Ordered by total number of views in descending order. */
3554
- VIEW_COUNT = "VIEW_COUNT",
3555
- /** Ordered by total number of likes in descending order. */
3556
- LIKE_COUNT = "LIKE_COUNT",
3557
- /** Ordered by `title` in ascending order. */
3558
- TITLE_ASC = "TITLE_ASC",
3559
- /** Ordered by `title` in descending order. */
3560
- TITLE_DESC = "TITLE_DESC"
3403
+ order?: OrderWithLiterals;
3404
+ /** Number of months to include in response. */
3405
+ months?: number;
3406
+ /**
3407
+ * Language filter.
3408
+ *
3409
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3410
+ * Pass a language to only receive the period post count for that specified language.
3411
+ * @format LANGUAGE_TAG
3412
+ */
3413
+ language?: string | null;
3414
+ /**
3415
+ * Time zone to use when calculating the start of the month.
3416
+ *
3417
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3418
+ * @minLength 3
3419
+ * @maxLength 100
3420
+ */
3421
+ timeZone?: string | null;
3561
3422
  }
3562
- /** @enumType */
3563
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3564
- declare enum PostFieldField {
3423
+ declare enum Order {
3565
3424
  UNKNOWN = "UNKNOWN",
3566
- /** Includes post URL when present. */
3567
- URL = "URL",
3568
- /** Includes post content text string when present. */
3569
- CONTENT_TEXT = "CONTENT_TEXT",
3570
- /** Includes post metrics when present. */
3571
- METRICS = "METRICS",
3572
- /** Includes SEO data. */
3573
- SEO = "SEO",
3574
- /** Includes post owner's contact ID. */
3575
- CONTACT_ID = "CONTACT_ID",
3576
- /** Includes post rich content. */
3577
- RICH_CONTENT = "RICH_CONTENT",
3578
- /** Includes post reference ID field. */
3579
- REFERENCE_ID = "REFERENCE_ID"
3425
+ OLDEST = "OLDEST",
3426
+ NEWEST = "NEWEST"
3580
3427
  }
3581
3428
  /** @enumType */
3582
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3583
- interface ListDemoPostsResponse {
3584
- /** List of posts. */
3585
- posts?: Post[];
3586
- /** Details on the paged set of results returned. */
3587
- metaData?: MetaData;
3429
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3430
+ /** Get Blog Post Count Stats response */
3431
+ interface QueryPostCountStatsResponse {
3432
+ /** List of published post counts by month. */
3433
+ stats?: PeriodPostCount[];
3588
3434
  }
3589
- interface ConvertDraftJsToRichContentRequest {
3590
- /** DraftJs content to convert to Rich content. */
3591
- content?: Record<string, any> | null;
3435
+ /** Post count for a specific time period */
3436
+ interface PeriodPostCount {
3437
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3438
+ periodStart?: Date | null;
3439
+ /** Number of posts published during this month. */
3440
+ postCount?: number;
3592
3441
  }
3593
- interface ConvertDraftJsToRichContentResponse {
3442
+ interface GetTotalPublicationsRequest {
3594
3443
  /**
3595
- * Rich content converted from DraftJs content.
3596
- * @maxLength 2000000
3444
+ * Language filter
3445
+ * @minLength 2
3446
+ * @format LANGUAGE_TAG
3597
3447
  */
3598
- richContent?: string;
3448
+ language?: string | null;
3599
3449
  }
3600
- interface ConvertRichContentToDraftJsRequest {
3450
+ interface GetTotalPublicationsResponse {
3451
+ /** Total amount of publications. */
3452
+ total?: number;
3453
+ }
3454
+ interface GetTotalPostsRequest {
3601
3455
  /**
3602
- * Rich content to convert to DraftJs content.
3603
- * @maxLength 2000000
3456
+ * Language filter.
3457
+ *
3458
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3459
+ * Pass a language to receive the total amount of posts in that specified language.
3460
+ * @format LANGUAGE_TAG
3604
3461
  */
3605
- richContent?: string;
3462
+ language?: string | null;
3606
3463
  }
3607
- interface ConvertRichContentToDraftJsResponse {
3608
- /** DraftJs content converted from Rich content. */
3609
- content?: Record<string, any> | null;
3464
+ interface GetTotalPostsResponse {
3465
+ /** Total amount of published posts. */
3466
+ total?: number;
3467
+ }
3468
+ interface GetTotalLikesPerMemberRequest {
3469
+ /**
3470
+ * Member ID.
3471
+ * @format GUID
3472
+ */
3473
+ memberId?: string;
3474
+ }
3475
+ interface GetTotalLikesPerMemberResponse {
3476
+ /** The total number of likes of the member. */
3477
+ total?: number;
3610
3478
  }
3611
3479
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3612
3480
  /**
@@ -3677,6 +3545,25 @@ interface GetPostRequest {
3677
3545
  */
3678
3546
  fieldsets?: PostFieldFieldWithLiterals[];
3679
3547
  }
3548
+ declare enum PostFieldField {
3549
+ UNKNOWN = "UNKNOWN",
3550
+ /** Includes post URL when present. */
3551
+ URL = "URL",
3552
+ /** Includes post content text string when present. */
3553
+ CONTENT_TEXT = "CONTENT_TEXT",
3554
+ /** Includes post metrics when present. */
3555
+ METRICS = "METRICS",
3556
+ /** Includes SEO data. */
3557
+ SEO = "SEO",
3558
+ /** Includes post owner's contact ID. */
3559
+ CONTACT_ID = "CONTACT_ID",
3560
+ /** Includes post rich content. */
3561
+ RICH_CONTENT = "RICH_CONTENT",
3562
+ /** Includes post reference ID field. */
3563
+ REFERENCE_ID = "REFERENCE_ID"
3564
+ }
3565
+ /** @enumType */
3566
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3680
3567
  interface GetPostResponse {
3681
3568
  /** Retrieved post info. */
3682
3569
  post?: Post;
@@ -3769,6 +3656,24 @@ interface ListPostsRequest {
3769
3656
  */
3770
3657
  fieldsets?: PostFieldFieldWithLiterals[];
3771
3658
  }
3659
+ declare enum GetPostsSort {
3660
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3661
+ FEED = "FEED",
3662
+ /** Ordered by `firstPublishedDate` in ascending order. */
3663
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3664
+ /** Ordered by `firstPublishedDate` in descending order. */
3665
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3666
+ /** Ordered by total number of views in descending order. */
3667
+ VIEW_COUNT = "VIEW_COUNT",
3668
+ /** Ordered by total number of likes in descending order. */
3669
+ LIKE_COUNT = "LIKE_COUNT",
3670
+ /** Ordered by `title` in ascending order. */
3671
+ TITLE_ASC = "TITLE_ASC",
3672
+ /** Ordered by `title` in descending order. */
3673
+ TITLE_DESC = "TITLE_DESC"
3674
+ }
3675
+ /** @enumType */
3676
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3772
3677
  interface ListPostsResponse {
3773
3678
  /** List of retrieved posts. */
3774
3679
  posts?: Post[];
@@ -4118,6 +4023,121 @@ interface PostCount {
4118
4023
  /** Number of posts. */
4119
4024
  postCount?: number;
4120
4025
  }
4026
+ interface ListDemoPostsRequest {
4027
+ /**
4028
+ * Whether to return only featured posts.
4029
+ *
4030
+ * Default: `false`
4031
+ */
4032
+ featured?: boolean;
4033
+ /**
4034
+ * Hashtag filter.
4035
+ *
4036
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4037
+ * If omitted, all posts with or without hashtags are returned.
4038
+ * @maxSize 100
4039
+ * @maxLength 100
4040
+ */
4041
+ hashtags?: string[];
4042
+ /**
4043
+ * Category filter.
4044
+ *
4045
+ * Pass an array of category IDs to return only posts with any of the provided categories.
4046
+ * If omitted, all posts with or without associated categories are returned.
4047
+ * @maxSize 50
4048
+ * @format GUID
4049
+ */
4050
+ categoryIds?: string[];
4051
+ /**
4052
+ * Tag filter.
4053
+ *
4054
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
4055
+ * If omitted, all posts with or without tags are returned.
4056
+ * @maxSize 50
4057
+ * @format GUID
4058
+ */
4059
+ tagIds?: string[];
4060
+ /**
4061
+ * Sorting options.
4062
+ *
4063
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4064
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4065
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4066
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4067
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4068
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
4069
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
4070
+ * - `RATING`: reserved for internal use.
4071
+ *
4072
+ * Default: `FEED`
4073
+ */
4074
+ sort?: GetPostsSortWithLiterals;
4075
+ /** Pagination options. */
4076
+ paging?: BlogPaging;
4077
+ /**
4078
+ * __Deprecated.__ Use `fieldsets` instead.
4079
+ * This parameter will be removed on June 30, 2023.
4080
+ *
4081
+ * List of post fields to be included in the response.
4082
+ * @maxSize 20
4083
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
4084
+ * This parameter will be removed on June 30, 2023.
4085
+ *
4086
+ * List of post fields to be included in the response.
4087
+ * @replacedBy fieldsets
4088
+ * @targetRemovalDate 2024-06-30
4089
+ */
4090
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
4091
+ /**
4092
+ * Language filter.
4093
+ *
4094
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4095
+ * Pass a language to only receive posts that are in that language.
4096
+ * If omitted, posts in all languages are returned.
4097
+ * @format LANGUAGE_TAG
4098
+ */
4099
+ language?: string | null;
4100
+ /**
4101
+ * Post owner's member ID.
4102
+ * @format GUID
4103
+ */
4104
+ memberId?: string | null;
4105
+ /**
4106
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4107
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4108
+ * only the post’s base fields are returned.
4109
+ * @maxSize 20
4110
+ */
4111
+ fieldsets?: PostFieldFieldWithLiterals[];
4112
+ }
4113
+ interface ListDemoPostsResponse {
4114
+ /** List of posts. */
4115
+ posts?: Post[];
4116
+ /** Details on the paged set of results returned. */
4117
+ metaData?: MetaData;
4118
+ }
4119
+ interface ConvertDraftJsToRichContentRequest {
4120
+ /** DraftJs content to convert to Rich content. */
4121
+ content?: Record<string, any> | null;
4122
+ }
4123
+ interface ConvertDraftJsToRichContentResponse {
4124
+ /**
4125
+ * Rich content converted from DraftJs content.
4126
+ * @maxLength 2000000
4127
+ */
4128
+ richContent?: string;
4129
+ }
4130
+ interface ConvertRichContentToDraftJsRequest {
4131
+ /**
4132
+ * Rich content to convert to DraftJs content.
4133
+ * @maxLength 2000000
4134
+ */
4135
+ richContent?: string;
4136
+ }
4137
+ interface ConvertRichContentToDraftJsResponse {
4138
+ /** DraftJs content converted from Rich content. */
4139
+ content?: Record<string, any> | null;
4140
+ }
4121
4141
  interface BaseEventMetadata {
4122
4142
  /**
4123
4143
  * App instance ID.
@@ -4265,13 +4285,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
4265
4285
  /**
4266
4286
  * Retrieves the number of published posts per month within a specified time range.
4267
4287
  *
4268
- * The time range is set using the `rangeStart` and `months` properties.
4269
- * The time range always starts on the 1st day of the month set in `rangeStart` and
4270
- * includes the number of `months` following `rangeStart`.
4271
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
4272
- * 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.
4273
- * > 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.
4288
+ *
4289
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
4290
+ *
4291
+ * 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.
4292
+ *
4293
+ * >**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.
4274
4294
  * @public
4295
+ * @param options - Options specifying time frame, sort, and filter.
4275
4296
  * @permissionId BLOG.READ-PUBLICATION
4276
4297
  * @applicableIdentity APP
4277
4298
  * @returns Get Blog Post Count Stats response
@@ -4312,6 +4333,7 @@ interface QueryPostCountStatsOptions {
4312
4333
  /**
4313
4334
  * Retrieves the total amount of published posts of the blog.
4314
4335
  * @public
4336
+ * @param options - Language Options.
4315
4337
  * @permissionId BLOG.READ-PUBLICATION
4316
4338
  * @applicableIdentity APP
4317
4339
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -4332,12 +4354,12 @@ interface GetTotalPostsOptions {
4332
4354
  * @param postId - Post ID.
4333
4355
  * @public
4334
4356
  * @requiredField postId
4357
+ * @param options - Options specifying which fields to return.
4335
4358
  * @permissionId BLOG.READ-PUBLICATION
4336
4359
  * @applicableIdentity APP
4337
- * @returns Retrieved post info.
4338
4360
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
4339
4361
  */
4340
- 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>>;
4362
+ 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>>;
4341
4363
  interface GetPostOptions {
4342
4364
  /**
4343
4365
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4357,6 +4379,7 @@ interface GetPostOptions {
4357
4379
  * @param slug - Slug of the post to retrieve.
4358
4380
  * @public
4359
4381
  * @requiredField slug
4382
+ * @param options - Options specifying which fields to return.
4360
4383
  * @permissionId BLOG.READ-PUBLICATION
4361
4384
  * @applicableIdentity APP
4362
4385
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -4384,6 +4407,7 @@ interface GetPostBySlugOptions {
4384
4407
  * - `paging.limit` is `50`.
4385
4408
  * - `paging.offset` is `0`.
4386
4409
  * @public
4410
+ * @param options - Sort, filter, and paging options.
4387
4411
  * @permissionId BLOG.READ-PUBLICATION
4388
4412
  * @applicableIdentity APP
4389
4413
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -4454,18 +4478,26 @@ interface ListPostsOptions {
4454
4478
  fieldsets?: PostFieldFieldWithLiterals[];
4455
4479
  }
4456
4480
  /**
4457
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
4481
+ * Creates a query to retrieve a list of posts.
4458
4482
  *
4459
- * Query Posts runs with these defaults, which you can override:
4460
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
4461
- * - `paging.limit` is `50`.
4462
- * - `paging.offset` is `0`.
4463
4483
  *
4464
- * To learn about working with _Query_ endpoints, see
4465
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
4466
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
4467
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
4484
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
4485
+ *
4486
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
4487
+ *
4488
+ * 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.
4489
+ *
4490
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
4491
+ * + `limit(50)`
4492
+ * + `descending('firstPublishedDate')`
4493
+ *
4494
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
4495
+ *
4496
+ * To learn how to query posts, refer to the table below.
4497
+ *
4498
+ * 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`.
4468
4499
  * @public
4500
+ * @param options - Options specifying which fields to return.
4469
4501
  * @permissionId BLOG.READ-PUBLICATION
4470
4502
  * @applicableIdentity APP
4471
4503
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
@@ -4731,4 +4763,4 @@ declare const utils: {
4731
4763
  */
4732
4764
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4733
4765
 
4734
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
4766
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };