@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
@@ -2123,7 +2123,7 @@ interface LayoutData {
2123
2123
  containerData?: PluginContainerData;
2124
2124
  /** Defines where selected design propertied applies to */
2125
2125
  designTarget?: DesignTargetWithLiterals;
2126
- /** Banner configuration. When present, this layout is displayed as a banner. */
2126
+ /** Banner configuration. When present, this layout is attached to a document edge (top or bottom). */
2127
2127
  banner?: Banner;
2128
2128
  /** Background styling (color or gradient). */
2129
2129
  background?: LayoutDataBackground;
@@ -2170,6 +2170,14 @@ declare enum BannerOrigin {
2170
2170
  }
2171
2171
  /** @enumType */
2172
2172
  type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
2173
+ declare enum BannerPosition {
2174
+ /** Attached to the top edge (banner) */
2175
+ TOP = "TOP",
2176
+ /** Attached to the bottom edge (footer) */
2177
+ BOTTOM = "BOTTOM"
2178
+ }
2179
+ /** @enumType */
2180
+ type BannerPositionWithLiterals = BannerPosition | 'TOP' | 'BOTTOM';
2173
2181
  /** Background type */
2174
2182
  declare enum LayoutDataBackgroundType {
2175
2183
  /** Solid color background */
@@ -2227,6 +2235,8 @@ type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
2227
2235
  interface Banner {
2228
2236
  /** Origin of the banner */
2229
2237
  origin?: BannerOriginWithLiterals;
2238
+ /** Position of the banner */
2239
+ position?: BannerPositionWithLiterals;
2230
2240
  }
2231
2241
  /** Background styling (color or gradient) */
2232
2242
  interface LayoutDataBackground {
@@ -2434,10 +2444,20 @@ declare enum SmartBlockDataType {
2434
2444
  /** Process steps with numbered/icon labels above a horizontal line. */
2435
2445
  PROCESS_STEPS = "PROCESS_STEPS",
2436
2446
  /** Statistics with bar visual elements. */
2437
- BAR_STATS = "BAR_STATS"
2447
+ BAR_STATS = "BAR_STATS",
2448
+ /** Timeline layout with numbered chips on a connecting line; cells alternate around the line. */
2449
+ TIMELINE = "TIMELINE",
2450
+ /** Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line. */
2451
+ MINIMAL_TIMELINE = "MINIMAL_TIMELINE",
2452
+ /** Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations. */
2453
+ PILLS = "PILLS",
2454
+ /** Star rating display with stars and a numeric value per cell. */
2455
+ STAR_RATING = "STAR_RATING",
2456
+ /** Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners. */
2457
+ QUOTE_BOXES = "QUOTE_BOXES"
2438
2458
  }
2439
2459
  /** @enumType */
2440
- 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';
2460
+ 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';
2441
2461
  /** Column size controlling how many cells appear per row. */
2442
2462
  declare enum ColumnSize {
2443
2463
  /** Up to 4 cells in a row. */
@@ -2751,598 +2771,314 @@ interface PostUnlikedInitiatorOneOf {
2751
2771
  */
2752
2772
  anonymousVisitorId?: string | null;
2753
2773
  }
2754
- interface GetTotalLikesPerMemberRequest {
2774
+ interface ListTemplatesRequest {
2755
2775
  /**
2756
- * Member ID.
2776
+ * Filter post templates by given template category ids
2777
+ * @maxSize 50
2757
2778
  * @format GUID
2758
2779
  */
2759
- memberId?: string;
2760
- }
2761
- interface GetTotalLikesPerMemberResponse {
2762
- /** The total number of likes of the member. */
2763
- total?: number;
2764
- }
2765
- interface DomainEvent extends DomainEventBodyOneOf {
2766
- createdEvent?: EntityCreatedEvent;
2767
- updatedEvent?: EntityUpdatedEvent;
2768
- deletedEvent?: EntityDeletedEvent;
2769
- actionEvent?: ActionEvent;
2770
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2771
- _id?: string;
2780
+ categoryIds?: string[];
2772
2781
  /**
2773
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2774
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2782
+ * Filter post templates by provided language
2783
+ * @format LANGUAGE_TAG
2775
2784
  */
2776
- entityFqdn?: string;
2785
+ language?: string | null;
2786
+ /** Returns post template categories when set to TRUE */
2787
+ listTemplateCategories?: boolean;
2788
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2789
+ sort?: GetPostTemplatesSortWithLiterals;
2790
+ /** Pagination options. */
2791
+ paging?: BlogPaging;
2792
+ }
2793
+ declare enum GetPostTemplatesSort {
2794
+ /** Sort by ascending publishing date. */
2795
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2796
+ /** Sort by descending publishing date. */
2797
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2798
+ }
2799
+ /** @enumType */
2800
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2801
+ interface BlogPaging {
2777
2802
  /**
2778
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2779
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2803
+ * Number of items to skip in the current sort order.
2804
+ *
2805
+ *
2806
+ * Default: `0`
2780
2807
  */
2781
- slug?: string;
2782
- /** ID of the entity associated with the event. */
2783
- entityId?: string;
2784
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2785
- eventTime?: Date | null;
2808
+ offset?: number;
2786
2809
  /**
2787
- * Whether the event was triggered as a result of a privacy regulation application
2788
- * (for example, GDPR).
2810
+ * Number of items to return.
2811
+ *
2812
+ *
2813
+ * Default:`50`
2814
+ * @min 1
2815
+ * @max 100
2789
2816
  */
2790
- triggeredByAnonymizeRequest?: boolean | null;
2791
- /** If present, indicates the action that triggered the event. */
2792
- originatedFrom?: string | null;
2817
+ limit?: number;
2793
2818
  /**
2794
- * 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.
2795
- * 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.
2819
+ * Pointer to the next or previous page in the list of results.
2820
+ * @maxLength 2000
2796
2821
  */
2797
- entityEventSequence?: string | null;
2798
- }
2799
- /** @oneof */
2800
- interface DomainEventBodyOneOf {
2801
- createdEvent?: EntityCreatedEvent;
2802
- updatedEvent?: EntityUpdatedEvent;
2803
- deletedEvent?: EntityDeletedEvent;
2804
- actionEvent?: ActionEvent;
2805
- }
2806
- interface EntityCreatedEvent {
2807
- entity?: string;
2822
+ cursor?: string | null;
2808
2823
  }
2809
- interface RestoreInfo {
2810
- deletedDate?: Date | null;
2824
+ interface ListTemplatesResponse {
2825
+ /** Available post templates */
2826
+ postTemplates?: Post[];
2827
+ /** Details on the paged set of posts templates returned. */
2828
+ postTemplatesMetaData?: MetaData;
2829
+ /** Post template categories. This value is returned empty unless asked explicitly */
2830
+ templateCategories?: Category[];
2811
2831
  }
2812
- interface EntityUpdatedEvent {
2832
+ interface MetaData {
2833
+ /** Number of items returned in this response. */
2834
+ count?: number;
2835
+ /** Requested offset. */
2836
+ offset?: number;
2837
+ /** Total number of items that match the query. */
2838
+ total?: number;
2813
2839
  /**
2814
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2815
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2816
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2840
+ * Pointer to the next or previous page in the list of results.
2841
+ * @maxLength 2000
2817
2842
  */
2818
- currentEntity?: string;
2819
- }
2820
- interface EntityDeletedEvent {
2821
- /** Entity that was deleted. */
2822
- deletedEntity?: string | null;
2823
- }
2824
- interface ActionEvent {
2825
- body?: string;
2843
+ cursor?: string | null;
2826
2844
  }
2827
- interface MessageEnvelope {
2845
+ interface Category {
2828
2846
  /**
2829
- * App instance ID.
2830
- * @format GUID
2847
+ * Category ID.
2848
+ * @immutable
2849
+ * @maxLength 38
2831
2850
  */
2832
- instanceId?: string | null;
2851
+ _id?: string;
2833
2852
  /**
2834
- * Event type.
2835
- * @maxLength 150
2853
+ * Category label. Displayed in the Category Menu.
2854
+ * @maxLength 35
2836
2855
  */
2837
- eventType?: string;
2838
- /** The identification type and identity data. */
2839
- identity?: IdentificationData;
2840
- /** Stringify payload. */
2841
- data?: string;
2842
- /** Details related to the account */
2843
- accountInfo?: AccountInfo;
2844
- }
2845
- interface IdentificationData extends IdentificationDataIdOneOf {
2856
+ label?: string;
2846
2857
  /**
2847
- * ID of a site visitor that has not logged in to the site.
2848
- * @format GUID
2858
+ * Number of posts in the category.
2859
+ * @readonly
2849
2860
  */
2850
- anonymousVisitorId?: string;
2861
+ postCount?: number;
2851
2862
  /**
2852
- * ID of a site visitor that has logged in to the site.
2853
- * @format GUID
2863
+ * The `url` of the page that lists every post with the specified category.
2864
+ * @readonly
2854
2865
  */
2855
- memberId?: string;
2866
+ url?: string;
2856
2867
  /**
2857
- * ID of a Wix user (site owner, contributor, etc.).
2858
- * @format GUID
2868
+ * Category description.
2869
+ * @maxLength 500
2859
2870
  */
2860
- wixUserId?: string;
2871
+ description?: string | null;
2861
2872
  /**
2862
- * ID of an app.
2863
- * @format GUID
2873
+ * Category title.
2874
+ * @maxLength 200
2875
+ * @deprecated Category title.
2876
+ * @targetRemovalDate 2025-07-16
2864
2877
  */
2865
- appId?: string;
2866
- /** @readonly */
2867
- identityType?: WebhookIdentityTypeWithLiterals;
2868
- }
2869
- /** @oneof */
2870
- interface IdentificationDataIdOneOf {
2878
+ title?: string;
2871
2879
  /**
2872
- * ID of a site visitor that has not logged in to the site.
2873
- * @format GUID
2880
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2881
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2882
+ *
2883
+ * Default: `-1`
2874
2884
  */
2875
- anonymousVisitorId?: string;
2885
+ displayPosition?: number | null;
2876
2886
  /**
2877
- * ID of a site visitor that has logged in to the site.
2887
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2878
2888
  * @format GUID
2879
2889
  */
2880
- memberId?: string;
2890
+ translationId?: string | null;
2881
2891
  /**
2882
- * ID of a Wix user (site owner, contributor, etc.).
2883
- * @format GUID
2892
+ * Category language.
2893
+ *
2894
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2895
+ * @immutable
2884
2896
  */
2885
- wixUserId?: string;
2897
+ language?: string | null;
2886
2898
  /**
2887
- * ID of an app.
2888
- * @format GUID
2899
+ * 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`.
2900
+ * @maxLength 100
2889
2901
  */
2890
- appId?: string;
2891
- }
2892
- declare enum WebhookIdentityType {
2893
- UNKNOWN = "UNKNOWN",
2894
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2895
- MEMBER = "MEMBER",
2896
- WIX_USER = "WIX_USER",
2897
- APP = "APP"
2898
- }
2899
- /** @enumType */
2900
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2901
- interface AccountInfo {
2902
+ slug?: string;
2903
+ /** SEO data. */
2904
+ seoData?: SeoSchema;
2905
+ /** Category cover image. */
2906
+ coverImage?: string;
2902
2907
  /**
2903
- * ID of the Wix account associated with the event.
2904
- * @format GUID
2908
+ * Date and time the Category was last updated.
2909
+ * @readonly
2905
2910
  */
2906
- accountId?: string | null;
2911
+ _updatedDate?: Date | null;
2912
+ }
2913
+ interface CategoryTranslation {
2907
2914
  /**
2908
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2915
+ * Category ID.
2909
2916
  * @format GUID
2910
2917
  */
2911
- parentAccountId?: string | null;
2918
+ _id?: string;
2912
2919
  /**
2913
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2914
- * @format GUID
2920
+ * Label displayed in the categories menu on the site.
2921
+ * @maxLength 100
2915
2922
  */
2916
- siteId?: string | null;
2917
- }
2918
- /** Get Blog Publications Count Stats request */
2919
- interface QueryPublicationsCountStatsRequest {
2920
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2921
- rangeStart?: Date | null;
2922
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2923
- rangeEnd?: Date | null;
2924
- /** Order of the returned results. */
2925
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2926
- /** Number of months to include in the response. */
2927
- months?: number;
2923
+ label?: string | null;
2928
2924
  /**
2929
- * Language filter
2930
- *
2931
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2925
+ * Language of the category.
2932
2926
  * @format LANGUAGE_TAG
2933
2927
  */
2934
2928
  language?: string | null;
2929
+ /** URL of this category page. */
2930
+ url?: string;
2931
+ }
2932
+ interface GetTemplateRequest {
2935
2933
  /**
2936
- * Timezone of the client.
2937
- * @minLength 3
2938
- * @maxLength 100
2934
+ * Post template id
2935
+ * @format GUID
2939
2936
  */
2940
- timeZone?: string | null;
2937
+ postTemplateId?: string;
2941
2938
  }
2942
- declare enum QueryPublicationsCountStatsRequestOrder {
2943
- UNKNOWN = "UNKNOWN",
2944
- OLDEST = "OLDEST",
2945
- NEWEST = "NEWEST"
2939
+ interface GetTemplateResponse {
2940
+ /** Post template */
2941
+ postTemplate?: Post;
2946
2942
  }
2947
- /** @enumType */
2948
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2949
- /** Get Blog Publications Count Stats response */
2950
- interface QueryPublicationsCountStatsResponse {
2951
- /** Chronologically ordered list of publications. */
2952
- stats?: PeriodPublicationsCount[];
2943
+ interface CreateDraftPostFromTemplateRequest {
2944
+ /**
2945
+ * Post template id
2946
+ * @format GUID
2947
+ */
2948
+ postTemplateId?: string;
2953
2949
  }
2954
- /** Publications count for a specific time period */
2955
- interface PeriodPublicationsCount {
2956
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2957
- periodStart?: Date | null;
2958
- /** Number of posts published during this month. */
2959
- publicationsCount?: number;
2950
+ interface CreateDraftPostFromTemplateResponse {
2951
+ /** Created draft post */
2952
+ draftPost?: DraftPost;
2960
2953
  }
2961
- /** Get Blog Post Count Stats request */
2962
- interface QueryPostCountStatsRequest {
2963
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2964
- rangeStart?: Date | null;
2954
+ interface DraftPost {
2965
2955
  /**
2966
- * Order of returned results.
2967
- *
2968
- * - `OLDEST`: posts by date in ascending order.
2969
- * - `NEWEST`: posts by date in descending order.
2970
- *
2971
- * Default: `OLDEST`
2956
+ * Draft post ID.
2957
+ * @readonly
2958
+ * @maxLength 38
2972
2959
  */
2973
- order?: OrderWithLiterals;
2974
- /** Number of months to include in response. */
2975
- months?: number;
2960
+ _id?: string;
2976
2961
  /**
2977
- * Language filter.
2978
- *
2979
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2980
- * Pass a language to only receive the period post count for that specified language.
2981
- * @format LANGUAGE_TAG
2962
+ * Draft post title.
2963
+ * @maxLength 200
2982
2964
  */
2983
- language?: string | null;
2965
+ title?: string;
2984
2966
  /**
2985
- * Time zone to use when calculating the start of the month.
2967
+ * Draft post excerpt.
2986
2968
  *
2987
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2988
- * @minLength 3
2969
+ * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2970
+ * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2971
+ * @maxLength 500
2972
+ */
2973
+ excerpt?: string | null;
2974
+ /** Whether the draft post is marked as featured. */
2975
+ featured?: boolean | null;
2976
+ /**
2977
+ * Category IDs of the draft post.
2978
+ * @maxSize 10
2979
+ * @maxLength 38
2980
+ */
2981
+ categoryIds?: string[];
2982
+ /**
2983
+ * Draft post owner's member ID.
2984
+ * @format GUID
2985
+ */
2986
+ memberId?: string | null;
2987
+ /**
2988
+ * Hashtags in the post.
2989
+ * @maxSize 100
2989
2990
  * @maxLength 100
2990
2991
  */
2991
- timeZone?: string | null;
2992
- }
2993
- declare enum Order {
2994
- UNKNOWN = "UNKNOWN",
2995
- OLDEST = "OLDEST",
2996
- NEWEST = "NEWEST"
2997
- }
2998
- /** @enumType */
2999
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3000
- /** Get Blog Post Count Stats response */
3001
- interface QueryPostCountStatsResponse {
3002
- /** List of published post counts by month. */
3003
- stats?: PeriodPostCount[];
3004
- }
3005
- /** Post count for a specific time period */
3006
- interface PeriodPostCount {
3007
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3008
- periodStart?: Date | null;
3009
- /** Number of posts published during this month. */
3010
- postCount?: number;
3011
- }
3012
- interface GetTotalPublicationsRequest {
2992
+ hashtags?: string[];
2993
+ /** Whether commenting on the draft post is enabled. */
2994
+ commentingEnabled?: boolean | null;
3013
2995
  /**
3014
- * Language filter
3015
- * @minLength 2
3016
- * @format LANGUAGE_TAG
2996
+ * Estimated reading time of the draft post (calculated automatically).
2997
+ * @readonly
3017
2998
  */
3018
- language?: string | null;
3019
- }
3020
- interface GetTotalPublicationsResponse {
3021
- /** Total amount of publications. */
3022
- total?: number;
3023
- }
3024
- interface GetTotalPostsRequest {
2999
+ minutesToRead?: number;
3000
+ /** Image placed at the top of the blog page. */
3001
+ heroImage?: string;
3025
3002
  /**
3026
- * Language filter.
3027
- *
3028
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3029
- * Pass a language to receive the total amount of posts in that specified language.
3030
- * @format LANGUAGE_TAG
3003
+ * Tag IDs the draft post is tagged with.
3004
+ * @maxSize 30
3005
+ * @maxLength 38
3031
3006
  */
3032
- language?: string | null;
3033
- }
3034
- interface GetTotalPostsResponse {
3035
- /** Total amount of published posts. */
3036
- total?: number;
3037
- }
3038
- interface ListTemplatesRequest {
3007
+ tagIds?: string[];
3039
3008
  /**
3040
- * Filter post templates by given template category ids
3041
- * @maxSize 50
3042
- * @format GUID
3009
+ * IDs of posts related to this draft post.
3010
+ * @maxSize 3
3011
+ * @maxLength 38
3043
3012
  */
3044
- categoryIds?: string[];
3013
+ relatedPostIds?: string[];
3045
3014
  /**
3046
- * Filter post templates by provided language
3047
- * @format LANGUAGE_TAG
3015
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3016
+ * @maxSize 100
3017
+ * @format GUID
3048
3018
  */
3049
- language?: string | null;
3050
- /** Returns post template categories when set to TRUE */
3051
- listTemplateCategories?: boolean;
3052
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
3053
- sort?: GetPostTemplatesSortWithLiterals;
3054
- /** Pagination options. */
3055
- paging?: BlogPaging;
3056
- }
3057
- declare enum GetPostTemplatesSort {
3058
- /** Sort by ascending publishing date. */
3059
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3060
- /** Sort by descending publishing date. */
3061
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
3062
- }
3063
- /** @enumType */
3064
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
3065
- interface BlogPaging {
3019
+ pricingPlanIds?: string[];
3066
3020
  /**
3067
- * Number of items to skip in the current sort order.
3068
- *
3021
+ * ID of the draft post's translations.
3069
3022
  *
3070
- * Default: `0`
3023
+ * All translations of a single post share the same `translationId`.
3024
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3025
+ * @format GUID
3071
3026
  */
3072
- offset?: number;
3027
+ translationId?: string | null;
3073
3028
  /**
3074
- * Number of items to return.
3075
- *
3029
+ * Language the draft post is written in.
3076
3030
  *
3077
- * Default:`50`
3078
- * @min 1
3079
- * @max 100
3031
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3032
+ * @format LANGUAGE_TAG
3080
3033
  */
3081
- limit?: number;
3034
+ language?: string | null;
3082
3035
  /**
3083
- * Pointer to the next or previous page in the list of results.
3084
- * @maxLength 2000
3036
+ * Draft Post rich content.
3037
+ *
3038
+ * <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">
3039
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3040
+ * </widget>
3085
3041
  */
3086
- cursor?: string | null;
3087
- }
3088
- interface ListTemplatesResponse {
3089
- /** Available post templates */
3090
- postTemplates?: Post[];
3091
- /** Details on the paged set of posts templates returned. */
3092
- postTemplatesMetaData?: MetaData;
3093
- /** Post template categories. This value is returned empty unless asked explicitly */
3094
- templateCategories?: Category[];
3095
- }
3096
- interface MetaData {
3097
- /** Number of items returned in this response. */
3098
- count?: number;
3099
- /** Requested offset. */
3100
- offset?: number;
3101
- /** Total number of items that match the query. */
3102
- total?: number;
3042
+ richContent?: RichContent;
3103
3043
  /**
3104
- * Pointer to the next or previous page in the list of results.
3105
- * @maxLength 2000
3044
+ * Status of the draft post.
3045
+ * @readonly
3106
3046
  */
3107
- cursor?: string | null;
3108
- }
3109
- interface Category {
3047
+ status?: StatusWithLiterals;
3048
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3049
+ moderationDetails?: ModerationDetails;
3110
3050
  /**
3111
- * Category ID.
3112
- * @immutable
3113
- * @maxLength 38
3051
+ * Indicates if there are changes made to the draft post that have not yet been published.
3052
+ * @readonly
3114
3053
  */
3115
- _id?: string;
3054
+ hasUnpublishedChanges?: boolean;
3116
3055
  /**
3117
- * Category label. Displayed in the Category Menu.
3118
- * @maxLength 35
3056
+ * Date the draft post was last edited.
3057
+ * @readonly
3119
3058
  */
3120
- label?: string;
3059
+ editedDate?: Date | null;
3121
3060
  /**
3122
- * Number of posts in the category.
3061
+ * Date the draft post is scheduled to be published.
3123
3062
  * @readonly
3124
3063
  */
3125
- postCount?: number;
3064
+ scheduledPublishDate?: Date | null;
3065
+ /** Date the post was first published. */
3066
+ firstPublishedDate?: Date | null;
3067
+ /** SEO data. */
3068
+ seoData?: SeoSchema;
3126
3069
  /**
3127
- * The `url` of the page that lists every post with the specified category.
3070
+ * Draft post URL preview. What the URL will look like once the post is published.
3128
3071
  * @readonly
3129
3072
  */
3130
3073
  url?: string;
3131
3074
  /**
3132
- * Category description.
3133
- * @maxLength 500
3075
+ * Date the draft post was first created.
3076
+ * @readonly
3134
3077
  */
3135
- description?: string | null;
3078
+ _createdDate?: Date | null;
3136
3079
  /**
3137
- * Category title.
3138
- * @maxLength 200
3139
- * @deprecated Category title.
3140
- * @targetRemovalDate 2025-07-16
3141
- */
3142
- title?: string;
3143
- /**
3144
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
3145
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
3146
- *
3147
- * Default: `-1`
3148
- */
3149
- displayPosition?: number | null;
3150
- /**
3151
- * ID of the category's translations. All translations of a single category share the same `translationId`.
3152
- * @format GUID
3153
- */
3154
- translationId?: string | null;
3155
- /**
3156
- * Category language.
3157
- *
3158
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3159
- * @immutable
3160
- */
3161
- language?: string | null;
3162
- /**
3163
- * 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`.
3164
- * @maxLength 100
3165
- */
3166
- slug?: string;
3167
- /** SEO data. */
3168
- seoData?: SeoSchema;
3169
- /** Category cover image. */
3170
- coverImage?: string;
3171
- /**
3172
- * Date and time the Category was last updated.
3173
- * @readonly
3174
- */
3175
- _updatedDate?: Date | null;
3176
- }
3177
- interface CategoryTranslation {
3178
- /**
3179
- * Category ID.
3180
- * @format GUID
3181
- */
3182
- _id?: string;
3183
- /**
3184
- * Label displayed in the categories menu on the site.
3185
- * @maxLength 100
3186
- */
3187
- label?: string | null;
3188
- /**
3189
- * Language of the category.
3190
- * @format LANGUAGE_TAG
3191
- */
3192
- language?: string | null;
3193
- /** URL of this category page. */
3194
- url?: string;
3195
- }
3196
- interface GetTemplateRequest {
3197
- /**
3198
- * Post template id
3199
- * @format GUID
3200
- */
3201
- postTemplateId?: string;
3202
- }
3203
- interface GetTemplateResponse {
3204
- /** Post template */
3205
- postTemplate?: Post;
3206
- }
3207
- interface CreateDraftPostFromTemplateRequest {
3208
- /**
3209
- * Post template id
3210
- * @format GUID
3211
- */
3212
- postTemplateId?: string;
3213
- }
3214
- interface CreateDraftPostFromTemplateResponse {
3215
- /** Created draft post */
3216
- draftPost?: DraftPost;
3217
- }
3218
- interface DraftPost {
3219
- /**
3220
- * Draft post ID.
3221
- * @readonly
3222
- * @maxLength 38
3223
- */
3224
- _id?: string;
3225
- /**
3226
- * Draft post title.
3227
- * @maxLength 200
3228
- */
3229
- title?: string;
3230
- /**
3231
- * Draft post excerpt.
3232
- *
3233
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3234
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3235
- * @maxLength 500
3236
- */
3237
- excerpt?: string | null;
3238
- /** Whether the draft post is marked as featured. */
3239
- featured?: boolean | null;
3240
- /**
3241
- * Category IDs of the draft post.
3242
- * @maxSize 10
3243
- * @maxLength 38
3244
- */
3245
- categoryIds?: string[];
3246
- /**
3247
- * Draft post owner's member ID.
3248
- * @format GUID
3249
- */
3250
- memberId?: string | null;
3251
- /**
3252
- * Hashtags in the post.
3253
- * @maxSize 100
3254
- * @maxLength 100
3255
- */
3256
- hashtags?: string[];
3257
- /** Whether commenting on the draft post is enabled. */
3258
- commentingEnabled?: boolean | null;
3259
- /**
3260
- * Estimated reading time of the draft post (calculated automatically).
3261
- * @readonly
3262
- */
3263
- minutesToRead?: number;
3264
- /** Image placed at the top of the blog page. */
3265
- heroImage?: string;
3266
- /**
3267
- * Tag IDs the draft post is tagged with.
3268
- * @maxSize 30
3269
- * @maxLength 38
3270
- */
3271
- tagIds?: string[];
3272
- /**
3273
- * IDs of posts related to this draft post.
3274
- * @maxSize 3
3275
- * @maxLength 38
3276
- */
3277
- relatedPostIds?: string[];
3278
- /**
3279
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3280
- * @maxSize 100
3281
- * @format GUID
3282
- */
3283
- pricingPlanIds?: string[];
3284
- /**
3285
- * ID of the draft post's translations.
3286
- *
3287
- * All translations of a single post share the same `translationId`.
3288
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3289
- * @format GUID
3290
- */
3291
- translationId?: string | null;
3292
- /**
3293
- * Language the draft post is written in.
3294
- *
3295
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3296
- * @format LANGUAGE_TAG
3297
- */
3298
- language?: string | null;
3299
- /**
3300
- * Draft Post rich content.
3301
- *
3302
- * <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">
3303
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3304
- * </widget>
3305
- */
3306
- richContent?: RichContent;
3307
- /**
3308
- * Status of the draft post.
3309
- * @readonly
3310
- */
3311
- status?: StatusWithLiterals;
3312
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3313
- moderationDetails?: ModerationDetails;
3314
- /**
3315
- * Indicates if there are changes made to the draft post that have not yet been published.
3316
- * @readonly
3317
- */
3318
- hasUnpublishedChanges?: boolean;
3319
- /**
3320
- * Date the draft post was last edited.
3321
- * @readonly
3322
- */
3323
- editedDate?: Date | null;
3324
- /**
3325
- * Date the draft post is scheduled to be published.
3326
- * @readonly
3327
- */
3328
- scheduledPublishDate?: Date | null;
3329
- /** Date the post was first published. */
3330
- firstPublishedDate?: Date | null;
3331
- /** SEO data. */
3332
- seoData?: SeoSchema;
3333
- /**
3334
- * Draft post URL preview. What the URL will look like once the post is published.
3335
- * @readonly
3336
- */
3337
- url?: string;
3338
- /**
3339
- * Date the draft post was first created.
3340
- * @readonly
3341
- */
3342
- _createdDate?: Date | null;
3343
- /**
3344
- * SEO slug.
3345
- * @maxLength 100
3080
+ * SEO slug.
3081
+ * @maxLength 100
3346
3082
  */
3347
3083
  seoSlug?: string | null;
3348
3084
  /** Post cover media. */
@@ -3463,157 +3199,289 @@ interface DraftPostTranslation {
3463
3199
  /** Post URL. */
3464
3200
  url?: string;
3465
3201
  }
3466
- interface ListDemoPostsRequest {
3202
+ interface DomainEvent extends DomainEventBodyOneOf {
3203
+ createdEvent?: EntityCreatedEvent;
3204
+ updatedEvent?: EntityUpdatedEvent;
3205
+ deletedEvent?: EntityDeletedEvent;
3206
+ actionEvent?: ActionEvent;
3207
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3208
+ _id?: string;
3467
3209
  /**
3468
- * Whether to return only featured posts.
3469
- *
3470
- * Default: `false`
3210
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3211
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3471
3212
  */
3472
- featured?: boolean;
3213
+ entityFqdn?: string;
3473
3214
  /**
3474
- * Hashtag filter.
3475
- *
3476
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3477
- * If omitted, all posts with or without hashtags are returned.
3478
- * @maxSize 100
3479
- * @maxLength 100
3215
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3216
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3480
3217
  */
3481
- hashtags?: string[];
3218
+ slug?: string;
3219
+ /** ID of the entity associated with the event. */
3220
+ entityId?: string;
3221
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3222
+ eventTime?: Date | null;
3482
3223
  /**
3483
- * Category filter.
3484
- *
3485
- * Pass an array of category IDs to return only posts with any of the provided categories.
3486
- * If omitted, all posts with or without associated categories are returned.
3487
- * @maxSize 50
3224
+ * Whether the event was triggered as a result of a privacy regulation application
3225
+ * (for example, GDPR).
3226
+ */
3227
+ triggeredByAnonymizeRequest?: boolean | null;
3228
+ /** If present, indicates the action that triggered the event. */
3229
+ originatedFrom?: string | null;
3230
+ /**
3231
+ * 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.
3232
+ * 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.
3233
+ */
3234
+ entityEventSequence?: string | null;
3235
+ }
3236
+ /** @oneof */
3237
+ interface DomainEventBodyOneOf {
3238
+ createdEvent?: EntityCreatedEvent;
3239
+ updatedEvent?: EntityUpdatedEvent;
3240
+ deletedEvent?: EntityDeletedEvent;
3241
+ actionEvent?: ActionEvent;
3242
+ }
3243
+ interface EntityCreatedEvent {
3244
+ entity?: string;
3245
+ }
3246
+ interface RestoreInfo {
3247
+ deletedDate?: Date | null;
3248
+ }
3249
+ interface EntityUpdatedEvent {
3250
+ /**
3251
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3252
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3253
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3254
+ */
3255
+ currentEntity?: string;
3256
+ }
3257
+ interface EntityDeletedEvent {
3258
+ /** Entity that was deleted. */
3259
+ deletedEntity?: string | null;
3260
+ }
3261
+ interface ActionEvent {
3262
+ body?: string;
3263
+ }
3264
+ interface MessageEnvelope {
3265
+ /**
3266
+ * App instance ID.
3488
3267
  * @format GUID
3489
3268
  */
3490
- categoryIds?: string[];
3269
+ instanceId?: string | null;
3491
3270
  /**
3492
- * Tag filter.
3493
- *
3494
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3495
- * If omitted, all posts with or without tags are returned.
3496
- * @maxSize 50
3271
+ * Event type.
3272
+ * @maxLength 150
3273
+ */
3274
+ eventType?: string;
3275
+ /** The identification type and identity data. */
3276
+ identity?: IdentificationData;
3277
+ /** Stringify payload. */
3278
+ data?: string;
3279
+ /** Details related to the account */
3280
+ accountInfo?: AccountInfo;
3281
+ }
3282
+ interface IdentificationData extends IdentificationDataIdOneOf {
3283
+ /**
3284
+ * ID of a site visitor that has not logged in to the site.
3497
3285
  * @format GUID
3498
3286
  */
3499
- tagIds?: string[];
3287
+ anonymousVisitorId?: string;
3500
3288
  /**
3501
- * Sorting options.
3502
- *
3503
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3504
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3505
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3506
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3507
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3508
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3509
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3510
- * - `RATING`: reserved for internal use.
3511
- *
3512
- * Default: `FEED`
3289
+ * ID of a site visitor that has logged in to the site.
3290
+ * @format GUID
3513
3291
  */
3514
- sort?: GetPostsSortWithLiterals;
3515
- /** Pagination options. */
3516
- paging?: BlogPaging;
3292
+ memberId?: string;
3517
3293
  /**
3518
- * __Deprecated.__ Use `fieldsets` instead.
3519
- * This parameter will be removed on June 30, 2023.
3520
- *
3521
- * List of post fields to be included in the response.
3522
- * @maxSize 20
3523
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
3524
- * This parameter will be removed on June 30, 2023.
3525
- *
3526
- * List of post fields to be included in the response.
3527
- * @replacedBy fieldsets
3528
- * @targetRemovalDate 2024-06-30
3294
+ * ID of a Wix user (site owner, contributor, etc.).
3295
+ * @format GUID
3529
3296
  */
3530
- fieldsToInclude?: PostFieldFieldWithLiterals[];
3297
+ wixUserId?: string;
3531
3298
  /**
3532
- * Language filter.
3299
+ * ID of an app.
3300
+ * @format GUID
3301
+ */
3302
+ appId?: string;
3303
+ /** @readonly */
3304
+ identityType?: WebhookIdentityTypeWithLiterals;
3305
+ }
3306
+ /** @oneof */
3307
+ interface IdentificationDataIdOneOf {
3308
+ /**
3309
+ * ID of a site visitor that has not logged in to the site.
3310
+ * @format GUID
3311
+ */
3312
+ anonymousVisitorId?: string;
3313
+ /**
3314
+ * ID of a site visitor that has logged in to the site.
3315
+ * @format GUID
3316
+ */
3317
+ memberId?: string;
3318
+ /**
3319
+ * ID of a Wix user (site owner, contributor, etc.).
3320
+ * @format GUID
3321
+ */
3322
+ wixUserId?: string;
3323
+ /**
3324
+ * ID of an app.
3325
+ * @format GUID
3326
+ */
3327
+ appId?: string;
3328
+ }
3329
+ declare enum WebhookIdentityType {
3330
+ UNKNOWN = "UNKNOWN",
3331
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3332
+ MEMBER = "MEMBER",
3333
+ WIX_USER = "WIX_USER",
3334
+ APP = "APP"
3335
+ }
3336
+ /** @enumType */
3337
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3338
+ interface AccountInfo {
3339
+ /**
3340
+ * ID of the Wix account associated with the event.
3341
+ * @format GUID
3342
+ */
3343
+ accountId?: string | null;
3344
+ /**
3345
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
3346
+ * @format GUID
3347
+ */
3348
+ parentAccountId?: string | null;
3349
+ /**
3350
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3351
+ * @format GUID
3352
+ */
3353
+ siteId?: string | null;
3354
+ }
3355
+ /** Get Blog Publications Count Stats request */
3356
+ interface QueryPublicationsCountStatsRequest {
3357
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3358
+ rangeStart?: Date | null;
3359
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3360
+ rangeEnd?: Date | null;
3361
+ /** Order of the returned results. */
3362
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3363
+ /** Number of months to include in the response. */
3364
+ months?: number;
3365
+ /**
3366
+ * Language filter
3533
3367
  *
3534
3368
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3535
- * Pass a language to only receive posts that are in that language.
3536
- * If omitted, posts in all languages are returned.
3537
3369
  * @format LANGUAGE_TAG
3538
3370
  */
3539
3371
  language?: string | null;
3540
3372
  /**
3541
- * Post owner's member ID.
3542
- * @format GUID
3373
+ * Timezone of the client.
3374
+ * @minLength 3
3375
+ * @maxLength 100
3543
3376
  */
3544
- memberId?: string | null;
3377
+ timeZone?: string | null;
3378
+ }
3379
+ declare enum QueryPublicationsCountStatsRequestOrder {
3380
+ UNKNOWN = "UNKNOWN",
3381
+ OLDEST = "OLDEST",
3382
+ NEWEST = "NEWEST"
3383
+ }
3384
+ /** @enumType */
3385
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3386
+ /** Get Blog Publications Count Stats response */
3387
+ interface QueryPublicationsCountStatsResponse {
3388
+ /** Chronologically ordered list of publications. */
3389
+ stats?: PeriodPublicationsCount[];
3390
+ }
3391
+ /** Publications count for a specific time period */
3392
+ interface PeriodPublicationsCount {
3393
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3394
+ periodStart?: Date | null;
3395
+ /** Number of posts published during this month. */
3396
+ publicationsCount?: number;
3397
+ }
3398
+ /** Get Blog Post Count Stats request */
3399
+ interface QueryPostCountStatsRequest {
3400
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3401
+ rangeStart?: Date | null;
3545
3402
  /**
3546
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3547
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3548
- * only the post’s base fields are returned.
3549
- * @maxSize 20
3403
+ * Order of returned results.
3404
+ *
3405
+ * - `OLDEST`: posts by date in ascending order.
3406
+ * - `NEWEST`: posts by date in descending order.
3407
+ *
3408
+ * Default: `OLDEST`
3550
3409
  */
3551
- fieldsets?: PostFieldFieldWithLiterals[];
3552
- }
3553
- declare enum GetPostsSort {
3554
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3555
- FEED = "FEED",
3556
- /** Ordered by `firstPublishedDate` in ascending order. */
3557
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3558
- /** Ordered by `firstPublishedDate` in descending order. */
3559
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3560
- /** Ordered by total number of views in descending order. */
3561
- VIEW_COUNT = "VIEW_COUNT",
3562
- /** Ordered by total number of likes in descending order. */
3563
- LIKE_COUNT = "LIKE_COUNT",
3564
- /** Ordered by `title` in ascending order. */
3565
- TITLE_ASC = "TITLE_ASC",
3566
- /** Ordered by `title` in descending order. */
3567
- TITLE_DESC = "TITLE_DESC"
3410
+ order?: OrderWithLiterals;
3411
+ /** Number of months to include in response. */
3412
+ months?: number;
3413
+ /**
3414
+ * Language filter.
3415
+ *
3416
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3417
+ * Pass a language to only receive the period post count for that specified language.
3418
+ * @format LANGUAGE_TAG
3419
+ */
3420
+ language?: string | null;
3421
+ /**
3422
+ * Time zone to use when calculating the start of the month.
3423
+ *
3424
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3425
+ * @minLength 3
3426
+ * @maxLength 100
3427
+ */
3428
+ timeZone?: string | null;
3568
3429
  }
3569
- /** @enumType */
3570
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3571
- declare enum PostFieldField {
3430
+ declare enum Order {
3572
3431
  UNKNOWN = "UNKNOWN",
3573
- /** Includes post URL when present. */
3574
- URL = "URL",
3575
- /** Includes post content text string when present. */
3576
- CONTENT_TEXT = "CONTENT_TEXT",
3577
- /** Includes post metrics when present. */
3578
- METRICS = "METRICS",
3579
- /** Includes SEO data. */
3580
- SEO = "SEO",
3581
- /** Includes post owner's contact ID. */
3582
- CONTACT_ID = "CONTACT_ID",
3583
- /** Includes post rich content. */
3584
- RICH_CONTENT = "RICH_CONTENT",
3585
- /** Includes post reference ID field. */
3586
- REFERENCE_ID = "REFERENCE_ID"
3432
+ OLDEST = "OLDEST",
3433
+ NEWEST = "NEWEST"
3587
3434
  }
3588
3435
  /** @enumType */
3589
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3590
- interface ListDemoPostsResponse {
3591
- /** List of posts. */
3592
- posts?: Post[];
3593
- /** Details on the paged set of results returned. */
3594
- metaData?: MetaData;
3436
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3437
+ /** Get Blog Post Count Stats response */
3438
+ interface QueryPostCountStatsResponse {
3439
+ /** List of published post counts by month. */
3440
+ stats?: PeriodPostCount[];
3595
3441
  }
3596
- interface ConvertDraftJsToRichContentRequest {
3597
- /** DraftJs content to convert to Rich content. */
3598
- content?: Record<string, any> | null;
3442
+ /** Post count for a specific time period */
3443
+ interface PeriodPostCount {
3444
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3445
+ periodStart?: Date | null;
3446
+ /** Number of posts published during this month. */
3447
+ postCount?: number;
3599
3448
  }
3600
- interface ConvertDraftJsToRichContentResponse {
3449
+ interface GetTotalPublicationsRequest {
3601
3450
  /**
3602
- * Rich content converted from DraftJs content.
3603
- * @maxLength 2000000
3451
+ * Language filter
3452
+ * @minLength 2
3453
+ * @format LANGUAGE_TAG
3604
3454
  */
3605
- richContent?: string;
3455
+ language?: string | null;
3606
3456
  }
3607
- interface ConvertRichContentToDraftJsRequest {
3457
+ interface GetTotalPublicationsResponse {
3458
+ /** Total amount of publications. */
3459
+ total?: number;
3460
+ }
3461
+ interface GetTotalPostsRequest {
3608
3462
  /**
3609
- * Rich content to convert to DraftJs content.
3610
- * @maxLength 2000000
3463
+ * Language filter.
3464
+ *
3465
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3466
+ * Pass a language to receive the total amount of posts in that specified language.
3467
+ * @format LANGUAGE_TAG
3611
3468
  */
3612
- richContent?: string;
3469
+ language?: string | null;
3613
3470
  }
3614
- interface ConvertRichContentToDraftJsResponse {
3615
- /** DraftJs content converted from Rich content. */
3616
- content?: Record<string, any> | null;
3471
+ interface GetTotalPostsResponse {
3472
+ /** Total amount of published posts. */
3473
+ total?: number;
3474
+ }
3475
+ interface GetTotalLikesPerMemberRequest {
3476
+ /**
3477
+ * Member ID.
3478
+ * @format GUID
3479
+ */
3480
+ memberId?: string;
3481
+ }
3482
+ interface GetTotalLikesPerMemberResponse {
3483
+ /** The total number of likes of the member. */
3484
+ total?: number;
3617
3485
  }
3618
3486
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3619
3487
  /**
@@ -3684,6 +3552,25 @@ interface GetPostRequest {
3684
3552
  */
3685
3553
  fieldsets?: PostFieldFieldWithLiterals[];
3686
3554
  }
3555
+ declare enum PostFieldField {
3556
+ UNKNOWN = "UNKNOWN",
3557
+ /** Includes post URL when present. */
3558
+ URL = "URL",
3559
+ /** Includes post content text string when present. */
3560
+ CONTENT_TEXT = "CONTENT_TEXT",
3561
+ /** Includes post metrics when present. */
3562
+ METRICS = "METRICS",
3563
+ /** Includes SEO data. */
3564
+ SEO = "SEO",
3565
+ /** Includes post owner's contact ID. */
3566
+ CONTACT_ID = "CONTACT_ID",
3567
+ /** Includes post rich content. */
3568
+ RICH_CONTENT = "RICH_CONTENT",
3569
+ /** Includes post reference ID field. */
3570
+ REFERENCE_ID = "REFERENCE_ID"
3571
+ }
3572
+ /** @enumType */
3573
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3687
3574
  interface GetPostResponse {
3688
3575
  /** Retrieved post info. */
3689
3576
  post?: Post;
@@ -3776,6 +3663,24 @@ interface ListPostsRequest {
3776
3663
  */
3777
3664
  fieldsets?: PostFieldFieldWithLiterals[];
3778
3665
  }
3666
+ declare enum GetPostsSort {
3667
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3668
+ FEED = "FEED",
3669
+ /** Ordered by `firstPublishedDate` in ascending order. */
3670
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3671
+ /** Ordered by `firstPublishedDate` in descending order. */
3672
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3673
+ /** Ordered by total number of views in descending order. */
3674
+ VIEW_COUNT = "VIEW_COUNT",
3675
+ /** Ordered by total number of likes in descending order. */
3676
+ LIKE_COUNT = "LIKE_COUNT",
3677
+ /** Ordered by `title` in ascending order. */
3678
+ TITLE_ASC = "TITLE_ASC",
3679
+ /** Ordered by `title` in descending order. */
3680
+ TITLE_DESC = "TITLE_DESC"
3681
+ }
3682
+ /** @enumType */
3683
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3779
3684
  interface ListPostsResponse {
3780
3685
  /** List of retrieved posts. */
3781
3686
  posts?: Post[];
@@ -4125,6 +4030,121 @@ interface PostCount {
4125
4030
  /** Number of posts. */
4126
4031
  postCount?: number;
4127
4032
  }
4033
+ interface ListDemoPostsRequest {
4034
+ /**
4035
+ * Whether to return only featured posts.
4036
+ *
4037
+ * Default: `false`
4038
+ */
4039
+ featured?: boolean;
4040
+ /**
4041
+ * Hashtag filter.
4042
+ *
4043
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4044
+ * If omitted, all posts with or without hashtags are returned.
4045
+ * @maxSize 100
4046
+ * @maxLength 100
4047
+ */
4048
+ hashtags?: string[];
4049
+ /**
4050
+ * Category filter.
4051
+ *
4052
+ * Pass an array of category IDs to return only posts with any of the provided categories.
4053
+ * If omitted, all posts with or without associated categories are returned.
4054
+ * @maxSize 50
4055
+ * @format GUID
4056
+ */
4057
+ categoryIds?: string[];
4058
+ /**
4059
+ * Tag filter.
4060
+ *
4061
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
4062
+ * If omitted, all posts with or without tags are returned.
4063
+ * @maxSize 50
4064
+ * @format GUID
4065
+ */
4066
+ tagIds?: string[];
4067
+ /**
4068
+ * Sorting options.
4069
+ *
4070
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4071
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4072
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4073
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4074
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4075
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
4076
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
4077
+ * - `RATING`: reserved for internal use.
4078
+ *
4079
+ * Default: `FEED`
4080
+ */
4081
+ sort?: GetPostsSortWithLiterals;
4082
+ /** Pagination options. */
4083
+ paging?: BlogPaging;
4084
+ /**
4085
+ * __Deprecated.__ Use `fieldsets` instead.
4086
+ * This parameter will be removed on June 30, 2023.
4087
+ *
4088
+ * List of post fields to be included in the response.
4089
+ * @maxSize 20
4090
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
4091
+ * This parameter will be removed on June 30, 2023.
4092
+ *
4093
+ * List of post fields to be included in the response.
4094
+ * @replacedBy fieldsets
4095
+ * @targetRemovalDate 2024-06-30
4096
+ */
4097
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
4098
+ /**
4099
+ * Language filter.
4100
+ *
4101
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4102
+ * Pass a language to only receive posts that are in that language.
4103
+ * If omitted, posts in all languages are returned.
4104
+ * @format LANGUAGE_TAG
4105
+ */
4106
+ language?: string | null;
4107
+ /**
4108
+ * Post owner's member ID.
4109
+ * @format GUID
4110
+ */
4111
+ memberId?: string | null;
4112
+ /**
4113
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4114
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4115
+ * only the post’s base fields are returned.
4116
+ * @maxSize 20
4117
+ */
4118
+ fieldsets?: PostFieldFieldWithLiterals[];
4119
+ }
4120
+ interface ListDemoPostsResponse {
4121
+ /** List of posts. */
4122
+ posts?: Post[];
4123
+ /** Details on the paged set of results returned. */
4124
+ metaData?: MetaData;
4125
+ }
4126
+ interface ConvertDraftJsToRichContentRequest {
4127
+ /** DraftJs content to convert to Rich content. */
4128
+ content?: Record<string, any> | null;
4129
+ }
4130
+ interface ConvertDraftJsToRichContentResponse {
4131
+ /**
4132
+ * Rich content converted from DraftJs content.
4133
+ * @maxLength 2000000
4134
+ */
4135
+ richContent?: string;
4136
+ }
4137
+ interface ConvertRichContentToDraftJsRequest {
4138
+ /**
4139
+ * Rich content to convert to DraftJs content.
4140
+ * @maxLength 2000000
4141
+ */
4142
+ richContent?: string;
4143
+ }
4144
+ interface ConvertRichContentToDraftJsResponse {
4145
+ /** DraftJs content converted from Rich content. */
4146
+ content?: Record<string, any> | null;
4147
+ }
4128
4148
  interface BaseEventMetadata {
4129
4149
  /**
4130
4150
  * App instance ID.
@@ -4272,13 +4292,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
4272
4292
  /**
4273
4293
  * Retrieves the number of published posts per month within a specified time range.
4274
4294
  *
4275
- * The time range is set using the `rangeStart` and `months` properties.
4276
- * The time range always starts on the 1st day of the month set in `rangeStart` and
4277
- * includes the number of `months` following `rangeStart`.
4278
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
4279
- * 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.
4280
- * > 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.
4295
+ *
4296
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
4297
+ *
4298
+ * 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.
4299
+ *
4300
+ * >**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.
4281
4301
  * @public
4302
+ * @param options - Options specifying time frame, sort, and filter.
4282
4303
  * @permissionId BLOG.READ-PUBLICATION
4283
4304
  * @applicableIdentity APP
4284
4305
  * @returns Get Blog Post Count Stats response
@@ -4319,6 +4340,7 @@ interface QueryPostCountStatsOptions {
4319
4340
  /**
4320
4341
  * Retrieves the total amount of published posts of the blog.
4321
4342
  * @public
4343
+ * @param options - Language Options.
4322
4344
  * @permissionId BLOG.READ-PUBLICATION
4323
4345
  * @applicableIdentity APP
4324
4346
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -4339,12 +4361,12 @@ interface GetTotalPostsOptions {
4339
4361
  * @param postId - Post ID.
4340
4362
  * @public
4341
4363
  * @requiredField postId
4364
+ * @param options - Options specifying which fields to return.
4342
4365
  * @permissionId BLOG.READ-PUBLICATION
4343
4366
  * @applicableIdentity APP
4344
- * @returns Retrieved post info.
4345
4367
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
4346
4368
  */
4347
- 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>>;
4369
+ 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>>;
4348
4370
  interface GetPostOptions {
4349
4371
  /**
4350
4372
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4364,6 +4386,7 @@ interface GetPostOptions {
4364
4386
  * @param slug - Slug of the post to retrieve.
4365
4387
  * @public
4366
4388
  * @requiredField slug
4389
+ * @param options - Options specifying which fields to return.
4367
4390
  * @permissionId BLOG.READ-PUBLICATION
4368
4391
  * @applicableIdentity APP
4369
4392
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -4391,6 +4414,7 @@ interface GetPostBySlugOptions {
4391
4414
  * - `paging.limit` is `50`.
4392
4415
  * - `paging.offset` is `0`.
4393
4416
  * @public
4417
+ * @param options - Sort, filter, and paging options.
4394
4418
  * @permissionId BLOG.READ-PUBLICATION
4395
4419
  * @applicableIdentity APP
4396
4420
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -4461,18 +4485,26 @@ interface ListPostsOptions {
4461
4485
  fieldsets?: PostFieldFieldWithLiterals[];
4462
4486
  }
4463
4487
  /**
4464
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
4488
+ * Creates a query to retrieve a list of posts.
4465
4489
  *
4466
- * Query Posts runs with these defaults, which you can override:
4467
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
4468
- * - `paging.limit` is `50`.
4469
- * - `paging.offset` is `0`.
4470
4490
  *
4471
- * To learn about working with _Query_ endpoints, see
4472
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
4473
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
4474
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
4491
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
4492
+ *
4493
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
4494
+ *
4495
+ * 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.
4496
+ *
4497
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
4498
+ * + `limit(50)`
4499
+ * + `descending('firstPublishedDate')`
4500
+ *
4501
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
4502
+ *
4503
+ * To learn how to query posts, refer to the table below.
4504
+ *
4505
+ * 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`.
4475
4506
  * @public
4507
+ * @param options - Options specifying which fields to return.
4476
4508
  * @permissionId BLOG.READ-PUBLICATION
4477
4509
  * @applicableIdentity APP
4478
4510
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
@@ -4738,4 +4770,4 @@ declare const utils: {
4738
4770
  */
4739
4771
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4740
4772
 
4741
- 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 };
4773
+ 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 };