@wix/auto_sdk_blog_posts 1.0.158 → 1.0.160

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 +43 -85
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +185 -539
  5. package/build/cjs/index.typings.js +33 -80
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +154 -520
  8. package/build/cjs/meta.js +27 -74
  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 +42 -82
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +185 -539
  17. package/build/es/index.typings.mjs +32 -77
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +154 -520
  20. package/build/es/meta.mjs +26 -71
  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 +43 -85
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +185 -539
  29. package/build/internal/cjs/index.typings.js +33 -80
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +154 -520
  32. package/build/internal/cjs/meta.js +27 -74
  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 +42 -82
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +185 -539
  41. package/build/internal/es/index.typings.mjs +32 -77
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +154 -520
  44. package/build/internal/es/meta.mjs +26 -71
  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
@@ -1463,6 +1463,8 @@ interface Decoration extends DecorationDataOneOf {
1463
1463
  subscriptData?: boolean | null;
1464
1464
  /** Data for a font family decoration. */
1465
1465
  fontFamilyData?: FontFamilyData;
1466
+ /** Data for a hand-drawn sketch annotation decoration. */
1467
+ sketchData?: SketchData;
1466
1468
  /** The type of decoration to apply. */
1467
1469
  type?: DecorationTypeWithLiterals;
1468
1470
  }
@@ -1494,6 +1496,8 @@ interface DecorationDataOneOf {
1494
1496
  subscriptData?: boolean | null;
1495
1497
  /** Data for a font family decoration. */
1496
1498
  fontFamilyData?: FontFamilyData;
1499
+ /** Data for a hand-drawn sketch annotation decoration. */
1500
+ sketchData?: SketchData;
1497
1501
  }
1498
1502
  declare enum DecorationType {
1499
1503
  BOLD = "BOLD",
@@ -1509,10 +1513,11 @@ declare enum DecorationType {
1509
1513
  STRIKETHROUGH = "STRIKETHROUGH",
1510
1514
  SUPERSCRIPT = "SUPERSCRIPT",
1511
1515
  SUBSCRIPT = "SUBSCRIPT",
1512
- FONT_FAMILY = "FONT_FAMILY"
1516
+ FONT_FAMILY = "FONT_FAMILY",
1517
+ SKETCH = "SKETCH"
1513
1518
  }
1514
1519
  /** @enumType */
1515
- type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY';
1520
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY' | 'SKETCH';
1516
1521
  interface AnchorData {
1517
1522
  /** The target node's ID. */
1518
1523
  anchor?: string;
@@ -1555,6 +1560,27 @@ interface FontFamilyData {
1555
1560
  /** @maxLength 1000 */
1556
1561
  value?: string | null;
1557
1562
  }
1563
+ interface SketchData {
1564
+ /** The sketch annotation variant to draw over the text. */
1565
+ variant?: VariantWithLiterals;
1566
+ /**
1567
+ * Annotation color. Defaults to the theme action color.
1568
+ * @maxLength 19
1569
+ */
1570
+ color?: string | null;
1571
+ /** Whether the annotation animates on first paint. Defaults to `true`. */
1572
+ animate?: boolean | null;
1573
+ }
1574
+ declare enum Variant {
1575
+ UNDERLINE = "UNDERLINE",
1576
+ BOX = "BOX",
1577
+ CIRCLE = "CIRCLE",
1578
+ HIGHLIGHT = "HIGHLIGHT",
1579
+ STRIKETHROUGH = "STRIKETHROUGH",
1580
+ CROSSED_OFF = "CROSSED_OFF"
1581
+ }
1582
+ /** @enumType */
1583
+ type VariantWithLiterals = Variant | 'UNDERLINE' | 'BOX' | 'CIRCLE' | 'HIGHLIGHT' | 'STRIKETHROUGH' | 'CROSSED_OFF';
1558
1584
  interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1559
1585
  /** Data for embedded Wix Bookings content. */
1560
1586
  bookingData?: BookingData;
@@ -2164,14 +2190,14 @@ declare enum ImagePosition {
2164
2190
  }
2165
2191
  /** @enumType */
2166
2192
  type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
2167
- declare enum BannerOrigin {
2193
+ declare enum Origin {
2168
2194
  /** Banner originated from an image */
2169
2195
  IMAGE = "IMAGE",
2170
2196
  /** Banner originated from a layout */
2171
2197
  LAYOUT = "LAYOUT"
2172
2198
  }
2173
2199
  /** @enumType */
2174
- type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
2200
+ type OriginWithLiterals = Origin | 'IMAGE' | 'LAYOUT';
2175
2201
  declare enum BannerPosition {
2176
2202
  /** Attached to the top edge (banner) */
2177
2203
  TOP = "TOP",
@@ -2236,7 +2262,7 @@ declare enum DesignTarget {
2236
2262
  type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
2237
2263
  interface Banner {
2238
2264
  /** Origin of the banner */
2239
- origin?: BannerOriginWithLiterals;
2265
+ origin?: OriginWithLiterals;
2240
2266
  /** Position of the banner */
2241
2267
  position?: BannerPositionWithLiterals;
2242
2268
  }
@@ -2578,7 +2604,7 @@ interface ModerationDetails {
2578
2604
  /** Date the post was submitted for review. */
2579
2605
  submittedDate?: Date | null;
2580
2606
  /** Status indicating whether the submission was approved or rejected by the moderator. */
2581
- status?: ModerationStatusStatusWithLiterals;
2607
+ status?: StatusWithLiterals;
2582
2608
  /**
2583
2609
  * Member ID of the person who approved or rejected the post.
2584
2610
  * @format GUID
@@ -2587,13 +2613,13 @@ interface ModerationDetails {
2587
2613
  /** Date the post was approved or rejected. */
2588
2614
  moderationDate?: Date | null;
2589
2615
  }
2590
- declare enum ModerationStatusStatus {
2616
+ declare enum Status {
2591
2617
  UNKNOWN = "UNKNOWN",
2592
2618
  APPROVED = "APPROVED",
2593
2619
  REJECTED = "REJECTED"
2594
2620
  }
2595
2621
  /** @enumType */
2596
- type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
2622
+ type StatusWithLiterals = Status | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
2597
2623
  interface Media extends MediaMediaOneOf {
2598
2624
  /** Wix Media details. */
2599
2625
  wixMedia?: WixMedia;
@@ -2791,433 +2817,125 @@ interface PostUnlikedInitiatorOneOf {
2791
2817
  */
2792
2818
  anonymousVisitorId?: string | null;
2793
2819
  }
2794
- interface ListTemplatesRequest {
2795
- /**
2796
- * Filter post templates by given template category ids
2797
- * @maxSize 50
2798
- * @format GUID
2799
- */
2800
- categoryIds?: string[];
2801
- /**
2802
- * Filter post templates by provided language
2803
- * @format LANGUAGE_TAG
2804
- */
2805
- language?: string | null;
2806
- /** Returns post template categories when set to TRUE */
2807
- listTemplateCategories?: boolean;
2808
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2809
- sort?: GetPostTemplatesSortWithLiterals;
2810
- /** Pagination options. */
2811
- paging?: BlogPaging;
2812
- }
2813
- declare enum GetPostTemplatesSort {
2814
- /** Sort by ascending publishing date. */
2815
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2816
- /** Sort by descending publishing date. */
2817
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2818
- }
2819
- /** @enumType */
2820
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2821
- interface BlogPaging {
2822
- /**
2823
- * Number of items to skip in the current sort order.
2824
- *
2825
- *
2826
- * Default: `0`
2827
- */
2828
- offset?: number;
2829
- /**
2830
- * Number of items to return.
2831
- *
2832
- *
2833
- * Default:`50`
2834
- * @min 1
2835
- * @max 100
2836
- */
2837
- limit?: number;
2838
- /**
2839
- * Pointer to the next or previous page in the list of results.
2840
- * @maxLength 2000
2841
- */
2842
- cursor?: string | null;
2843
- }
2844
- interface ListTemplatesResponse {
2845
- /** Available post templates */
2846
- postTemplates?: Post[];
2847
- /** Details on the paged set of posts templates returned. */
2848
- postTemplatesMetaData?: MetaData;
2849
- /** Post template categories. This value is returned empty unless asked explicitly */
2850
- templateCategories?: Category[];
2851
- }
2852
- interface MetaData {
2853
- /** Number of items returned in this response. */
2854
- count?: number;
2855
- /** Requested offset. */
2856
- offset?: number;
2857
- /** Total number of items that match the query. */
2858
- total?: number;
2859
- /**
2860
- * Pointer to the next or previous page in the list of results.
2861
- * @maxLength 2000
2862
- */
2863
- cursor?: string | null;
2864
- }
2865
- interface Category {
2866
- /**
2867
- * Category ID.
2868
- * @immutable
2869
- * @maxLength 38
2870
- */
2871
- _id?: string;
2872
- /**
2873
- * Category label. Displayed in the Category Menu.
2874
- * @maxLength 35
2875
- */
2876
- label?: string;
2877
- /**
2878
- * Number of posts in the category.
2879
- * @readonly
2880
- */
2881
- postCount?: number;
2882
- /**
2883
- * The `url` of the page that lists every post with the specified category.
2884
- * @readonly
2885
- */
2886
- url?: string;
2887
- /**
2888
- * Category description.
2889
- * @maxLength 500
2890
- */
2891
- description?: string | null;
2892
- /**
2893
- * Category title.
2894
- * @maxLength 200
2895
- * @deprecated Category title.
2896
- * @targetRemovalDate 2025-07-16
2897
- */
2898
- title?: string;
2899
- /**
2900
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2901
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2902
- *
2903
- * Default: `-1`
2904
- */
2905
- displayPosition?: number | null;
2906
- /**
2907
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2908
- * @format GUID
2909
- */
2910
- translationId?: string | null;
2820
+ /** Get Blog Publications Count Stats request */
2821
+ interface QueryPublicationsCountStatsRequest {
2822
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2823
+ rangeStart?: Date | null;
2824
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2825
+ rangeEnd?: Date | null;
2826
+ /** Order of the returned results. */
2827
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2828
+ /** Number of months to include in the response. */
2829
+ months?: number;
2911
2830
  /**
2912
- * Category language.
2831
+ * Language filter
2913
2832
  *
2914
2833
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2915
- * @immutable
2916
- */
2917
- language?: string | null;
2918
- /**
2919
- * 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`.
2920
- * @maxLength 100
2921
- */
2922
- slug?: string;
2923
- /** SEO data. */
2924
- seoData?: SeoSchema;
2925
- /** Category cover image. */
2926
- coverImage?: string;
2927
- /**
2928
- * Date and time the Category was last updated.
2929
- * @readonly
2930
- */
2931
- _updatedDate?: Date | null;
2932
- }
2933
- interface CategoryTranslation {
2934
- /**
2935
- * Category ID.
2936
- * @format GUID
2937
- */
2938
- _id?: string;
2939
- /**
2940
- * Label displayed in the categories menu on the site.
2941
- * @maxLength 100
2942
- */
2943
- label?: string | null;
2944
- /**
2945
- * Language of the category.
2946
2834
  * @format LANGUAGE_TAG
2947
2835
  */
2948
2836
  language?: string | null;
2949
- /** URL of this category page. */
2950
- url?: string;
2951
- }
2952
- interface GetTemplateRequest {
2953
2837
  /**
2954
- * Post template id
2955
- * @format GUID
2838
+ * Timezone of the client.
2839
+ * @minLength 3
2840
+ * @maxLength 100
2956
2841
  */
2957
- postTemplateId?: string;
2842
+ timeZone?: string | null;
2958
2843
  }
2959
- interface GetTemplateResponse {
2960
- /** Post template */
2961
- postTemplate?: Post;
2844
+ declare enum QueryPublicationsCountStatsRequestOrder {
2845
+ UNKNOWN = "UNKNOWN",
2846
+ OLDEST = "OLDEST",
2847
+ NEWEST = "NEWEST"
2962
2848
  }
2963
- interface CreateDraftPostFromTemplateRequest {
2964
- /**
2965
- * Post template id
2966
- * @format GUID
2967
- */
2968
- postTemplateId?: string;
2849
+ /** @enumType */
2850
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2851
+ /** Get Blog Publications Count Stats response */
2852
+ interface QueryPublicationsCountStatsResponse {
2853
+ /** Chronologically ordered list of publications. */
2854
+ stats?: PeriodPublicationsCount[];
2969
2855
  }
2970
- interface CreateDraftPostFromTemplateResponse {
2971
- /** Created draft post */
2972
- draftPost?: DraftPost;
2856
+ /** Publications count for a specific time period */
2857
+ interface PeriodPublicationsCount {
2858
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2859
+ periodStart?: Date | null;
2860
+ /** Number of posts published during this month. */
2861
+ publicationsCount?: number;
2973
2862
  }
2974
- interface DraftPost {
2975
- /**
2976
- * Draft post ID.
2977
- * @readonly
2978
- * @maxLength 38
2979
- */
2980
- _id?: string;
2981
- /**
2982
- * Draft post title.
2983
- * @maxLength 200
2984
- */
2985
- title?: string;
2863
+ /** Get Blog Post Count Stats request */
2864
+ interface QueryPostCountStatsRequest {
2865
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2866
+ rangeStart?: Date | null;
2986
2867
  /**
2987
- * Draft post excerpt.
2868
+ * Order of returned results.
2988
2869
  *
2989
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2990
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2991
- * @maxLength 500
2992
- */
2993
- excerpt?: string | null;
2994
- /** Whether the draft post is marked as featured. */
2995
- featured?: boolean | null;
2996
- /**
2997
- * Category IDs of the draft post.
2998
- * @maxSize 10
2999
- * @maxLength 38
3000
- */
3001
- categoryIds?: string[];
3002
- /**
3003
- * Draft post owner's member ID.
3004
- * @format GUID
3005
- */
3006
- memberId?: string | null;
3007
- /**
3008
- * Hashtags in the post.
3009
- * @maxSize 100
3010
- * @maxLength 100
3011
- */
3012
- hashtags?: string[];
3013
- /** Whether commenting on the draft post is enabled. */
3014
- commentingEnabled?: boolean | null;
3015
- /**
3016
- * Estimated reading time of the draft post (calculated automatically).
3017
- * @readonly
3018
- */
3019
- minutesToRead?: number;
3020
- /** Image placed at the top of the blog page. */
3021
- heroImage?: string;
3022
- /**
3023
- * Tag IDs the draft post is tagged with.
3024
- * @maxSize 30
3025
- * @maxLength 38
3026
- */
3027
- tagIds?: string[];
3028
- /**
3029
- * IDs of posts related to this draft post.
3030
- * @maxSize 3
3031
- * @maxLength 38
3032
- */
3033
- relatedPostIds?: string[];
3034
- /**
3035
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3036
- * @maxSize 100
3037
- * @format GUID
3038
- */
3039
- pricingPlanIds?: string[];
3040
- /**
3041
- * ID of the draft post's translations.
2870
+ * - `OLDEST`: posts by date in ascending order.
2871
+ * - `NEWEST`: posts by date in descending order.
3042
2872
  *
3043
- * All translations of a single post share the same `translationId`.
3044
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3045
- * @format GUID
2873
+ * Default: `OLDEST`
3046
2874
  */
3047
- translationId?: string | null;
2875
+ order?: OrderWithLiterals;
2876
+ /** Number of months to include in response. */
2877
+ months?: number;
3048
2878
  /**
3049
- * Language the draft post is written in.
2879
+ * Language filter.
3050
2880
  *
3051
2881
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2882
+ * Pass a language to only receive the period post count for that specified language.
3052
2883
  * @format LANGUAGE_TAG
3053
2884
  */
3054
2885
  language?: string | null;
3055
2886
  /**
3056
- * Draft Post rich content.
2887
+ * Time zone to use when calculating the start of the month.
3057
2888
  *
3058
- * <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">
3059
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3060
- * </widget>
3061
- */
3062
- richContent?: RichContent;
3063
- /**
3064
- * Status of the draft post.
3065
- * @readonly
3066
- */
3067
- status?: StatusWithLiterals;
3068
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3069
- moderationDetails?: ModerationDetails;
3070
- /**
3071
- * Indicates if there are changes made to the draft post that have not yet been published.
3072
- * @readonly
3073
- */
3074
- hasUnpublishedChanges?: boolean;
3075
- /**
3076
- * Date the draft post was last edited.
3077
- * @readonly
3078
- */
3079
- editedDate?: Date | null;
3080
- /**
3081
- * Date the draft post is scheduled to be published.
3082
- * @readonly
3083
- */
3084
- scheduledPublishDate?: Date | null;
3085
- /** Date the post was first published. */
3086
- firstPublishedDate?: Date | null;
3087
- /** SEO data. */
3088
- seoData?: SeoSchema;
3089
- /**
3090
- * Draft post URL preview. What the URL will look like once the post is published.
3091
- * @readonly
3092
- */
3093
- url?: string;
3094
- /**
3095
- * Date the draft post was first created.
3096
- * @readonly
3097
- */
3098
- _createdDate?: Date | null;
3099
- /**
3100
- * SEO slug.
2889
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2890
+ * @minLength 3
3101
2891
  * @maxLength 100
3102
2892
  */
3103
- seoSlug?: string | null;
3104
- /** Post cover media. */
3105
- media?: Media;
3106
- /** Number of paragraphs to display in a paid content preview for non-paying users. */
3107
- previewTextParagraph?: number | null;
2893
+ timeZone?: string | null;
3108
2894
  }
3109
- declare enum Origin {
2895
+ declare enum Order {
3110
2896
  UNKNOWN = "UNKNOWN",
3111
- /** Changed by admin */
3112
- ADMIN = "ADMIN",
3113
- /** Categories were changed */
3114
- ADD_CATEGORIES = "ADD_CATEGORIES",
3115
- /** Saved automatically */
3116
- AUTO_SAVE = "AUTO_SAVE",
3117
- /** Copied from template */
3118
- COPY_TEMPLATE = "COPY_TEMPLATE",
3119
- /** Imported */
3120
- IMPORT = "IMPORT",
3121
- /** Imported in bulk */
3122
- IMPORT_BULK = "IMPORT_BULK",
3123
- /** Imported with html import */
3124
- IMPORT_HTML = "IMPORT_HTML",
3125
- /** Patch import */
3126
- IMPORT_PATCH = "IMPORT_PATCH",
3127
- /** Changed language */
3128
- LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
3129
- /** Saved manually */
3130
- MANUAL_SAVE = "MANUAL_SAVE",
3131
- /** Affected by migration */
3132
- MIGRATION = "MIGRATION",
3133
- /** Affected by moderation */
3134
- MODERATION = "MODERATION",
3135
- /** Moved to trash */
3136
- MOVE_TO_TRASH = "MOVE_TO_TRASH",
3137
- /** Pricing plans were changed */
3138
- PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
3139
- /** Was provisioned */
3140
- PROVISION = "PROVISION",
3141
- /** Was published */
3142
- PUBLISH = "PUBLISH",
3143
- /** Owner was reassigned */
3144
- REASSIGN_OWNER = "REASSIGN_OWNER",
3145
- /** Was reblogged */
3146
- REBLOG = "REBLOG",
3147
- /** Was restored */
3148
- RESTORE = "RESTORE",
3149
- /** Reverted to draft */
3150
- REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
3151
- /** Was translated */
3152
- TRANSLATION = "TRANSLATION",
3153
- /** Was unpublished */
3154
- UNPUBLISH = "UNPUBLISH",
3155
- /** Was unscheduled */
3156
- UNSCHEDULE = "UNSCHEDULE",
3157
- /** New edit session started which updated editing_session_id id */
3158
- NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
3159
- /** Was scheduled by Later */
3160
- SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
3161
- /** Was unscheduled by Later */
3162
- SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
3163
- /** Was published by Later */
3164
- SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
3165
- /** Was scheduled */
3166
- SCHEDULE = "SCHEDULE",
3167
- /** Was removed from moderation */
3168
- REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
3169
- /** Was rejected from moderation */
3170
- REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
3171
- /** Was approved in moderation */
3172
- APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
3173
- /** Tag was deleted */
3174
- DELETE_TAG = "DELETE_TAG",
3175
- /** Post was pinned */
3176
- PIN = "PIN",
3177
- /** Post was unpinned */
3178
- UNPIN = "UNPIN",
3179
- /** Saved automatically by AI tool. */
3180
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
2897
+ OLDEST = "OLDEST",
2898
+ NEWEST = "NEWEST"
3181
2899
  }
3182
2900
  /** @enumType */
3183
- type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
3184
- declare enum Status {
3185
- UNKNOWN = "UNKNOWN",
3186
- /** Status indicating the draft post is published. */
3187
- PUBLISHED = "PUBLISHED",
3188
- /** Status indicating the draft post is unpublished. */
3189
- UNPUBLISHED = "UNPUBLISHED",
3190
- /** Status indicating the draft post is scheduled for publication. */
3191
- SCHEDULED = "SCHEDULED",
3192
- /** Status indicating the draft post is deleted. */
3193
- DELETED = "DELETED",
3194
- /** Status indicating the draft post is in review. */
3195
- IN_REVIEW = "IN_REVIEW"
2901
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2902
+ /** Get Blog Post Count Stats response */
2903
+ interface QueryPostCountStatsResponse {
2904
+ /** List of published post counts by month. */
2905
+ stats?: PeriodPostCount[];
3196
2906
  }
3197
- /** @enumType */
3198
- type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
3199
- interface DraftPostTranslation {
3200
- /**
3201
- * Post ID.
3202
- * @format GUID
3203
- */
3204
- _id?: string;
3205
- /** Post status. */
3206
- status?: StatusWithLiterals;
2907
+ /** Post count for a specific time period */
2908
+ interface PeriodPostCount {
2909
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2910
+ periodStart?: Date | null;
2911
+ /** Number of posts published during this month. */
2912
+ postCount?: number;
2913
+ }
2914
+ interface GetTotalPublicationsRequest {
3207
2915
  /**
3208
- * Language the post is written in.
2916
+ * Language filter
2917
+ * @minLength 2
3209
2918
  * @format LANGUAGE_TAG
3210
2919
  */
3211
2920
  language?: string | null;
2921
+ }
2922
+ interface GetTotalPublicationsResponse {
2923
+ /** Total amount of publications. */
2924
+ total?: number;
2925
+ }
2926
+ interface GetTotalPostsRequest {
3212
2927
  /**
3213
- * Post slug. For example, 'post-slug'.
3214
- * @maxLength 100
2928
+ * Language filter.
2929
+ *
2930
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2931
+ * Pass a language to receive the total amount of posts in that specified language.
2932
+ * @format LANGUAGE_TAG
3215
2933
  */
3216
- slug?: string | null;
3217
- /** SEO data. */
3218
- seoData?: SeoSchema;
3219
- /** Post URL. */
3220
- url?: string;
2934
+ language?: string | null;
2935
+ }
2936
+ interface GetTotalPostsResponse {
2937
+ /** Total amount of published posts. */
2938
+ total?: number;
3221
2939
  }
3222
2940
  interface DomainEvent extends DomainEventBodyOneOf {
3223
2941
  createdEvent?: EntityCreatedEvent;
@@ -3248,7 +2966,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
3248
2966
  /** If present, indicates the action that triggered the event. */
3249
2967
  originatedFrom?: string | null;
3250
2968
  /**
3251
- * 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.
2969
+ * 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.
3252
2970
  * 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.
3253
2971
  */
3254
2972
  entityEventSequence?: string | null;
@@ -3372,126 +3090,6 @@ interface AccountInfo {
3372
3090
  */
3373
3091
  siteId?: string | null;
3374
3092
  }
3375
- /** Get Blog Publications Count Stats request */
3376
- interface QueryPublicationsCountStatsRequest {
3377
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3378
- rangeStart?: Date | null;
3379
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3380
- rangeEnd?: Date | null;
3381
- /** Order of the returned results. */
3382
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3383
- /** Number of months to include in the response. */
3384
- months?: number;
3385
- /**
3386
- * Language filter
3387
- *
3388
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3389
- * @format LANGUAGE_TAG
3390
- */
3391
- language?: string | null;
3392
- /**
3393
- * Timezone of the client.
3394
- * @minLength 3
3395
- * @maxLength 100
3396
- */
3397
- timeZone?: string | null;
3398
- }
3399
- declare enum QueryPublicationsCountStatsRequestOrder {
3400
- UNKNOWN = "UNKNOWN",
3401
- OLDEST = "OLDEST",
3402
- NEWEST = "NEWEST"
3403
- }
3404
- /** @enumType */
3405
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3406
- /** Get Blog Publications Count Stats response */
3407
- interface QueryPublicationsCountStatsResponse {
3408
- /** Chronologically ordered list of publications. */
3409
- stats?: PeriodPublicationsCount[];
3410
- }
3411
- /** Publications count for a specific time period */
3412
- interface PeriodPublicationsCount {
3413
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3414
- periodStart?: Date | null;
3415
- /** Number of posts published during this month. */
3416
- publicationsCount?: number;
3417
- }
3418
- /** Get Blog Post Count Stats request */
3419
- interface QueryPostCountStatsRequest {
3420
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3421
- rangeStart?: Date | null;
3422
- /**
3423
- * Order of returned results.
3424
- *
3425
- * - `OLDEST`: posts by date in ascending order.
3426
- * - `NEWEST`: posts by date in descending order.
3427
- *
3428
- * Default: `OLDEST`
3429
- */
3430
- order?: OrderWithLiterals;
3431
- /** Number of months to include in response. */
3432
- months?: number;
3433
- /**
3434
- * Language filter.
3435
- *
3436
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3437
- * Pass a language to only receive the period post count for that specified language.
3438
- * @format LANGUAGE_TAG
3439
- */
3440
- language?: string | null;
3441
- /**
3442
- * Time zone to use when calculating the start of the month.
3443
- *
3444
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3445
- * @minLength 3
3446
- * @maxLength 100
3447
- */
3448
- timeZone?: string | null;
3449
- }
3450
- declare enum Order {
3451
- UNKNOWN = "UNKNOWN",
3452
- OLDEST = "OLDEST",
3453
- NEWEST = "NEWEST"
3454
- }
3455
- /** @enumType */
3456
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3457
- /** Get Blog Post Count Stats response */
3458
- interface QueryPostCountStatsResponse {
3459
- /** List of published post counts by month. */
3460
- stats?: PeriodPostCount[];
3461
- }
3462
- /** Post count for a specific time period */
3463
- interface PeriodPostCount {
3464
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3465
- periodStart?: Date | null;
3466
- /** Number of posts published during this month. */
3467
- postCount?: number;
3468
- }
3469
- interface GetTotalPublicationsRequest {
3470
- /**
3471
- * Language filter
3472
- * @minLength 2
3473
- * @format LANGUAGE_TAG
3474
- */
3475
- language?: string | null;
3476
- }
3477
- interface GetTotalPublicationsResponse {
3478
- /** Total amount of publications. */
3479
- total?: number;
3480
- }
3481
- interface GetTotalPostsRequest {
3482
- /**
3483
- * Language filter.
3484
- *
3485
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3486
- * Pass a language to receive the total amount of posts in that specified language.
3487
- * @format LANGUAGE_TAG
3488
- */
3489
- language?: string | null;
3490
- }
3491
- interface GetTotalPostsResponse {
3492
- /** Total amount of published posts. */
3493
- total?: number;
3494
- }
3495
3093
  interface GetTotalLikesPerMemberRequest {
3496
3094
  /**
3497
3095
  * Member ID.
@@ -3701,12 +3299,48 @@ declare enum GetPostsSort {
3701
3299
  }
3702
3300
  /** @enumType */
3703
3301
  type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3302
+ interface BlogPaging {
3303
+ /**
3304
+ * Number of items to skip in the current sort order.
3305
+ *
3306
+ *
3307
+ * Default: `0`
3308
+ */
3309
+ offset?: number;
3310
+ /**
3311
+ * Number of items to return.
3312
+ *
3313
+ *
3314
+ * Default:`50`
3315
+ * @min 1
3316
+ * @max 100
3317
+ */
3318
+ limit?: number;
3319
+ /**
3320
+ * Pointer to the next or previous page in the list of results.
3321
+ * @maxLength 2000
3322
+ */
3323
+ cursor?: string | null;
3324
+ }
3704
3325
  interface ListPostsResponse {
3705
3326
  /** List of retrieved posts. */
3706
3327
  posts?: Post[];
3707
3328
  /** Details on the paged set of results returned. */
3708
3329
  metaData?: MetaData;
3709
3330
  }
3331
+ interface MetaData {
3332
+ /** Number of items returned in this response. */
3333
+ count?: number;
3334
+ /** Requested offset. */
3335
+ offset?: number;
3336
+ /** Total number of items that match the query. */
3337
+ total?: number;
3338
+ /**
3339
+ * Pointer to the next or previous page in the list of results.
3340
+ * @maxLength 2000
3341
+ */
3342
+ cursor?: string | null;
3343
+ }
3710
3344
  interface QueryPostsRequest {
3711
3345
  /** Query options. */
3712
3346
  query?: PlatformQuery;
@@ -4206,7 +3840,7 @@ interface EventMetadata extends BaseEventMetadata {
4206
3840
  /** If present, indicates the action that triggered the event. */
4207
3841
  originatedFrom?: string | null;
4208
3842
  /**
4209
- * 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.
3843
+ * 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.
4210
3844
  * 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.
4211
3845
  */
4212
3846
  entityEventSequence?: string | null;
@@ -4312,13 +3946,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
4312
3946
  /**
4313
3947
  * Retrieves the number of published posts per month within a specified time range.
4314
3948
  *
4315
- * The time range is set using the `rangeStart` and `months` properties.
4316
- * The time range always starts on the 1st day of the month set in `rangeStart` and
4317
- * includes the number of `months` following `rangeStart`.
4318
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
4319
- * 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.
4320
- * > 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.
3949
+ *
3950
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
3951
+ *
3952
+ * 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.
3953
+ *
3954
+ * >**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.
4321
3955
  * @public
3956
+ * @param options - Options specifying time frame, sort, and filter.
4322
3957
  * @permissionId BLOG.READ-PUBLICATION
4323
3958
  * @applicableIdentity APP
4324
3959
  * @returns Get Blog Post Count Stats response
@@ -4359,6 +3994,7 @@ interface QueryPostCountStatsOptions {
4359
3994
  /**
4360
3995
  * Retrieves the total amount of published posts of the blog.
4361
3996
  * @public
3997
+ * @param options - Language Options.
4362
3998
  * @permissionId BLOG.READ-PUBLICATION
4363
3999
  * @applicableIdentity APP
4364
4000
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -4379,12 +4015,12 @@ interface GetTotalPostsOptions {
4379
4015
  * @param postId - Post ID.
4380
4016
  * @public
4381
4017
  * @requiredField postId
4018
+ * @param options - Options specifying which fields to return.
4382
4019
  * @permissionId BLOG.READ-PUBLICATION
4383
4020
  * @applicableIdentity APP
4384
- * @returns Retrieved post info.
4385
4021
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
4386
4022
  */
4387
- 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>>;
4023
+ 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>>;
4388
4024
  interface GetPostOptions {
4389
4025
  /**
4390
4026
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4404,6 +4040,7 @@ interface GetPostOptions {
4404
4040
  * @param slug - Slug of the post to retrieve.
4405
4041
  * @public
4406
4042
  * @requiredField slug
4043
+ * @param options - Options specifying which fields to return.
4407
4044
  * @permissionId BLOG.READ-PUBLICATION
4408
4045
  * @applicableIdentity APP
4409
4046
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -4431,6 +4068,7 @@ interface GetPostBySlugOptions {
4431
4068
  * - `paging.limit` is `50`.
4432
4069
  * - `paging.offset` is `0`.
4433
4070
  * @public
4071
+ * @param options - Sort, filter, and paging options.
4434
4072
  * @permissionId BLOG.READ-PUBLICATION
4435
4073
  * @applicableIdentity APP
4436
4074
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -4501,18 +4139,26 @@ interface ListPostsOptions {
4501
4139
  fieldsets?: PostFieldFieldWithLiterals[];
4502
4140
  }
4503
4141
  /**
4504
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
4142
+ * Creates a query to retrieve a list of posts.
4505
4143
  *
4506
- * Query Posts runs with these defaults, which you can override:
4507
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
4508
- * - `paging.limit` is `50`.
4509
- * - `paging.offset` is `0`.
4510
4144
  *
4511
- * To learn about working with _Query_ endpoints, see
4512
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
4513
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
4514
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
4145
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
4146
+ *
4147
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
4148
+ *
4149
+ * 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.
4150
+ *
4151
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
4152
+ * + `limit(50)`
4153
+ * + `descending('firstPublishedDate')`
4154
+ *
4155
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
4156
+ *
4157
+ * To learn how to query posts, refer to the table below.
4158
+ *
4159
+ * 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`.
4515
4160
  * @public
4161
+ * @param options - Options specifying which fields to return.
4516
4162
  * @permissionId BLOG.READ-PUBLICATION
4517
4163
  * @applicableIdentity APP
4518
4164
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
@@ -4762,7 +4408,7 @@ declare const utils: {
4762
4408
  query: {
4763
4409
  QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4764
4410
  Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4765
- Sort: _wix_sdk_types.SortFactory<PostQuerySpec>; /** Data for a color decoration. */
4411
+ Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
4766
4412
  };
4767
4413
  };
4768
4414
  /**
@@ -4778,4 +4424,4 @@ declare const utils: {
4778
4424
  */
4779
4425
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4780
4426
 
4781
- 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 CheckboxListData, 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 ListItemNodeData, 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 };
4427
+ 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, 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 CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, 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 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, GetPostsSort, type GetPostsSortWithLiterals, 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 ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, 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, 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 SketchData, 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, Variant, type VariantWithLiterals, 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 };