@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
@@ -1470,6 +1470,8 @@ interface Decoration extends DecorationDataOneOf {
1470
1470
  subscriptData?: boolean | null;
1471
1471
  /** Data for a font family decoration. */
1472
1472
  fontFamilyData?: FontFamilyData;
1473
+ /** Data for a hand-drawn sketch annotation decoration. */
1474
+ sketchData?: SketchData;
1473
1475
  /** The type of decoration to apply. */
1474
1476
  type?: DecorationTypeWithLiterals;
1475
1477
  }
@@ -1501,6 +1503,8 @@ interface DecorationDataOneOf {
1501
1503
  subscriptData?: boolean | null;
1502
1504
  /** Data for a font family decoration. */
1503
1505
  fontFamilyData?: FontFamilyData;
1506
+ /** Data for a hand-drawn sketch annotation decoration. */
1507
+ sketchData?: SketchData;
1504
1508
  }
1505
1509
  declare enum DecorationType {
1506
1510
  BOLD = "BOLD",
@@ -1516,10 +1520,11 @@ declare enum DecorationType {
1516
1520
  STRIKETHROUGH = "STRIKETHROUGH",
1517
1521
  SUPERSCRIPT = "SUPERSCRIPT",
1518
1522
  SUBSCRIPT = "SUBSCRIPT",
1519
- FONT_FAMILY = "FONT_FAMILY"
1523
+ FONT_FAMILY = "FONT_FAMILY",
1524
+ SKETCH = "SKETCH"
1520
1525
  }
1521
1526
  /** @enumType */
1522
- type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY';
1527
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY' | 'SKETCH';
1523
1528
  interface AnchorData {
1524
1529
  /** The target node's ID. */
1525
1530
  anchor?: string;
@@ -1562,6 +1567,27 @@ interface FontFamilyData {
1562
1567
  /** @maxLength 1000 */
1563
1568
  value?: string | null;
1564
1569
  }
1570
+ interface SketchData {
1571
+ /** The sketch annotation variant to draw over the text. */
1572
+ variant?: VariantWithLiterals;
1573
+ /**
1574
+ * Annotation color. Defaults to the theme action color.
1575
+ * @maxLength 19
1576
+ */
1577
+ color?: string | null;
1578
+ /** Whether the annotation animates on first paint. Defaults to `true`. */
1579
+ animate?: boolean | null;
1580
+ }
1581
+ declare enum Variant {
1582
+ UNDERLINE = "UNDERLINE",
1583
+ BOX = "BOX",
1584
+ CIRCLE = "CIRCLE",
1585
+ HIGHLIGHT = "HIGHLIGHT",
1586
+ STRIKETHROUGH = "STRIKETHROUGH",
1587
+ CROSSED_OFF = "CROSSED_OFF"
1588
+ }
1589
+ /** @enumType */
1590
+ type VariantWithLiterals = Variant | 'UNDERLINE' | 'BOX' | 'CIRCLE' | 'HIGHLIGHT' | 'STRIKETHROUGH' | 'CROSSED_OFF';
1565
1591
  interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1566
1592
  /** Data for embedded Wix Bookings content. */
1567
1593
  bookingData?: BookingData;
@@ -2171,14 +2197,14 @@ declare enum ImagePosition {
2171
2197
  }
2172
2198
  /** @enumType */
2173
2199
  type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
2174
- declare enum BannerOrigin {
2200
+ declare enum Origin {
2175
2201
  /** Banner originated from an image */
2176
2202
  IMAGE = "IMAGE",
2177
2203
  /** Banner originated from a layout */
2178
2204
  LAYOUT = "LAYOUT"
2179
2205
  }
2180
2206
  /** @enumType */
2181
- type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
2207
+ type OriginWithLiterals = Origin | 'IMAGE' | 'LAYOUT';
2182
2208
  declare enum BannerPosition {
2183
2209
  /** Attached to the top edge (banner) */
2184
2210
  TOP = "TOP",
@@ -2243,7 +2269,7 @@ declare enum DesignTarget {
2243
2269
  type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
2244
2270
  interface Banner {
2245
2271
  /** Origin of the banner */
2246
- origin?: BannerOriginWithLiterals;
2272
+ origin?: OriginWithLiterals;
2247
2273
  /** Position of the banner */
2248
2274
  position?: BannerPositionWithLiterals;
2249
2275
  }
@@ -2585,7 +2611,7 @@ interface ModerationDetails {
2585
2611
  /** Date the post was submitted for review. */
2586
2612
  submittedDate?: Date | null;
2587
2613
  /** Status indicating whether the submission was approved or rejected by the moderator. */
2588
- status?: ModerationStatusStatusWithLiterals;
2614
+ status?: StatusWithLiterals;
2589
2615
  /**
2590
2616
  * Member ID of the person who approved or rejected the post.
2591
2617
  * @format GUID
@@ -2594,13 +2620,13 @@ interface ModerationDetails {
2594
2620
  /** Date the post was approved or rejected. */
2595
2621
  moderationDate?: Date | null;
2596
2622
  }
2597
- declare enum ModerationStatusStatus {
2623
+ declare enum Status {
2598
2624
  UNKNOWN = "UNKNOWN",
2599
2625
  APPROVED = "APPROVED",
2600
2626
  REJECTED = "REJECTED"
2601
2627
  }
2602
2628
  /** @enumType */
2603
- type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
2629
+ type StatusWithLiterals = Status | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
2604
2630
  interface Media extends MediaMediaOneOf {
2605
2631
  /** Wix Media details. */
2606
2632
  wixMedia?: WixMedia;
@@ -2798,433 +2824,125 @@ interface PostUnlikedInitiatorOneOf {
2798
2824
  */
2799
2825
  anonymousVisitorId?: string | null;
2800
2826
  }
2801
- interface ListTemplatesRequest {
2802
- /**
2803
- * Filter post templates by given template category ids
2804
- * @maxSize 50
2805
- * @format GUID
2806
- */
2807
- categoryIds?: string[];
2808
- /**
2809
- * Filter post templates by provided language
2810
- * @format LANGUAGE_TAG
2811
- */
2812
- language?: string | null;
2813
- /** Returns post template categories when set to TRUE */
2814
- listTemplateCategories?: boolean;
2815
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2816
- sort?: GetPostTemplatesSortWithLiterals;
2817
- /** Pagination options. */
2818
- paging?: BlogPaging;
2819
- }
2820
- declare enum GetPostTemplatesSort {
2821
- /** Sort by ascending publishing date. */
2822
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2823
- /** Sort by descending publishing date. */
2824
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2825
- }
2826
- /** @enumType */
2827
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2828
- interface BlogPaging {
2829
- /**
2830
- * Number of items to skip in the current sort order.
2831
- *
2832
- *
2833
- * Default: `0`
2834
- */
2835
- offset?: number;
2836
- /**
2837
- * Number of items to return.
2838
- *
2839
- *
2840
- * Default:`50`
2841
- * @min 1
2842
- * @max 100
2843
- */
2844
- limit?: number;
2845
- /**
2846
- * Pointer to the next or previous page in the list of results.
2847
- * @maxLength 2000
2848
- */
2849
- cursor?: string | null;
2850
- }
2851
- interface ListTemplatesResponse {
2852
- /** Available post templates */
2853
- postTemplates?: Post[];
2854
- /** Details on the paged set of posts templates returned. */
2855
- postTemplatesMetaData?: MetaData;
2856
- /** Post template categories. This value is returned empty unless asked explicitly */
2857
- templateCategories?: Category[];
2858
- }
2859
- interface MetaData {
2860
- /** Number of items returned in this response. */
2861
- count?: number;
2862
- /** Requested offset. */
2863
- offset?: number;
2864
- /** Total number of items that match the query. */
2865
- total?: number;
2866
- /**
2867
- * Pointer to the next or previous page in the list of results.
2868
- * @maxLength 2000
2869
- */
2870
- cursor?: string | null;
2871
- }
2872
- interface Category {
2873
- /**
2874
- * Category ID.
2875
- * @immutable
2876
- * @maxLength 38
2877
- */
2878
- _id?: string;
2879
- /**
2880
- * Category label. Displayed in the Category Menu.
2881
- * @maxLength 35
2882
- */
2883
- label?: string;
2884
- /**
2885
- * Number of posts in the category.
2886
- * @readonly
2887
- */
2888
- postCount?: number;
2889
- /**
2890
- * The `url` of the page that lists every post with the specified category.
2891
- * @readonly
2892
- */
2893
- url?: string;
2894
- /**
2895
- * Category description.
2896
- * @maxLength 500
2897
- */
2898
- description?: string | null;
2899
- /**
2900
- * Category title.
2901
- * @maxLength 200
2902
- * @deprecated Category title.
2903
- * @targetRemovalDate 2025-07-16
2904
- */
2905
- title?: string;
2906
- /**
2907
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2908
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2909
- *
2910
- * Default: `-1`
2911
- */
2912
- displayPosition?: number | null;
2913
- /**
2914
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2915
- * @format GUID
2916
- */
2917
- translationId?: string | null;
2827
+ /** Get Blog Publications Count Stats request */
2828
+ interface QueryPublicationsCountStatsRequest {
2829
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2830
+ rangeStart?: Date | null;
2831
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2832
+ rangeEnd?: Date | null;
2833
+ /** Order of the returned results. */
2834
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2835
+ /** Number of months to include in the response. */
2836
+ months?: number;
2918
2837
  /**
2919
- * Category language.
2838
+ * Language filter
2920
2839
  *
2921
2840
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2922
- * @immutable
2923
- */
2924
- language?: string | null;
2925
- /**
2926
- * 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`.
2927
- * @maxLength 100
2928
- */
2929
- slug?: string;
2930
- /** SEO data. */
2931
- seoData?: SeoSchema;
2932
- /** Category cover image. */
2933
- coverImage?: string;
2934
- /**
2935
- * Date and time the Category was last updated.
2936
- * @readonly
2937
- */
2938
- _updatedDate?: Date | null;
2939
- }
2940
- interface CategoryTranslation {
2941
- /**
2942
- * Category ID.
2943
- * @format GUID
2944
- */
2945
- _id?: string;
2946
- /**
2947
- * Label displayed in the categories menu on the site.
2948
- * @maxLength 100
2949
- */
2950
- label?: string | null;
2951
- /**
2952
- * Language of the category.
2953
2841
  * @format LANGUAGE_TAG
2954
2842
  */
2955
2843
  language?: string | null;
2956
- /** URL of this category page. */
2957
- url?: string;
2958
- }
2959
- interface GetTemplateRequest {
2960
2844
  /**
2961
- * Post template id
2962
- * @format GUID
2845
+ * Timezone of the client.
2846
+ * @minLength 3
2847
+ * @maxLength 100
2963
2848
  */
2964
- postTemplateId?: string;
2849
+ timeZone?: string | null;
2965
2850
  }
2966
- interface GetTemplateResponse {
2967
- /** Post template */
2968
- postTemplate?: Post;
2851
+ declare enum QueryPublicationsCountStatsRequestOrder {
2852
+ UNKNOWN = "UNKNOWN",
2853
+ OLDEST = "OLDEST",
2854
+ NEWEST = "NEWEST"
2969
2855
  }
2970
- interface CreateDraftPostFromTemplateRequest {
2971
- /**
2972
- * Post template id
2973
- * @format GUID
2974
- */
2975
- postTemplateId?: string;
2856
+ /** @enumType */
2857
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2858
+ /** Get Blog Publications Count Stats response */
2859
+ interface QueryPublicationsCountStatsResponse {
2860
+ /** Chronologically ordered list of publications. */
2861
+ stats?: PeriodPublicationsCount[];
2976
2862
  }
2977
- interface CreateDraftPostFromTemplateResponse {
2978
- /** Created draft post */
2979
- draftPost?: DraftPost;
2863
+ /** Publications count for a specific time period */
2864
+ interface PeriodPublicationsCount {
2865
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2866
+ periodStart?: Date | null;
2867
+ /** Number of posts published during this month. */
2868
+ publicationsCount?: number;
2980
2869
  }
2981
- interface DraftPost {
2982
- /**
2983
- * Draft post ID.
2984
- * @readonly
2985
- * @maxLength 38
2986
- */
2987
- _id?: string;
2988
- /**
2989
- * Draft post title.
2990
- * @maxLength 200
2991
- */
2992
- title?: string;
2870
+ /** Get Blog Post Count Stats request */
2871
+ interface QueryPostCountStatsRequest {
2872
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2873
+ rangeStart?: Date | null;
2993
2874
  /**
2994
- * Draft post excerpt.
2875
+ * Order of returned results.
2995
2876
  *
2996
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2997
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2998
- * @maxLength 500
2999
- */
3000
- excerpt?: string | null;
3001
- /** Whether the draft post is marked as featured. */
3002
- featured?: boolean | null;
3003
- /**
3004
- * Category IDs of the draft post.
3005
- * @maxSize 10
3006
- * @maxLength 38
3007
- */
3008
- categoryIds?: string[];
3009
- /**
3010
- * Draft post owner's member ID.
3011
- * @format GUID
3012
- */
3013
- memberId?: string | null;
3014
- /**
3015
- * Hashtags in the post.
3016
- * @maxSize 100
3017
- * @maxLength 100
3018
- */
3019
- hashtags?: string[];
3020
- /** Whether commenting on the draft post is enabled. */
3021
- commentingEnabled?: boolean | null;
3022
- /**
3023
- * Estimated reading time of the draft post (calculated automatically).
3024
- * @readonly
3025
- */
3026
- minutesToRead?: number;
3027
- /** Image placed at the top of the blog page. */
3028
- heroImage?: string;
3029
- /**
3030
- * Tag IDs the draft post is tagged with.
3031
- * @maxSize 30
3032
- * @maxLength 38
3033
- */
3034
- tagIds?: string[];
3035
- /**
3036
- * IDs of posts related to this draft post.
3037
- * @maxSize 3
3038
- * @maxLength 38
3039
- */
3040
- relatedPostIds?: string[];
3041
- /**
3042
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3043
- * @maxSize 100
3044
- * @format GUID
3045
- */
3046
- pricingPlanIds?: string[];
3047
- /**
3048
- * ID of the draft post's translations.
2877
+ * - `OLDEST`: posts by date in ascending order.
2878
+ * - `NEWEST`: posts by date in descending order.
3049
2879
  *
3050
- * All translations of a single post share the same `translationId`.
3051
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3052
- * @format GUID
2880
+ * Default: `OLDEST`
3053
2881
  */
3054
- translationId?: string | null;
2882
+ order?: OrderWithLiterals;
2883
+ /** Number of months to include in response. */
2884
+ months?: number;
3055
2885
  /**
3056
- * Language the draft post is written in.
2886
+ * Language filter.
3057
2887
  *
3058
2888
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2889
+ * Pass a language to only receive the period post count for that specified language.
3059
2890
  * @format LANGUAGE_TAG
3060
2891
  */
3061
2892
  language?: string | null;
3062
2893
  /**
3063
- * Draft Post rich content.
2894
+ * Time zone to use when calculating the start of the month.
3064
2895
  *
3065
- * <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">
3066
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3067
- * </widget>
3068
- */
3069
- richContent?: RichContent;
3070
- /**
3071
- * Status of the draft post.
3072
- * @readonly
3073
- */
3074
- status?: StatusWithLiterals;
3075
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3076
- moderationDetails?: ModerationDetails;
3077
- /**
3078
- * Indicates if there are changes made to the draft post that have not yet been published.
3079
- * @readonly
3080
- */
3081
- hasUnpublishedChanges?: boolean;
3082
- /**
3083
- * Date the draft post was last edited.
3084
- * @readonly
3085
- */
3086
- editedDate?: Date | null;
3087
- /**
3088
- * Date the draft post is scheduled to be published.
3089
- * @readonly
3090
- */
3091
- scheduledPublishDate?: Date | null;
3092
- /** Date the post was first published. */
3093
- firstPublishedDate?: Date | null;
3094
- /** SEO data. */
3095
- seoData?: SeoSchema;
3096
- /**
3097
- * Draft post URL preview. What the URL will look like once the post is published.
3098
- * @readonly
3099
- */
3100
- url?: string;
3101
- /**
3102
- * Date the draft post was first created.
3103
- * @readonly
3104
- */
3105
- _createdDate?: Date | null;
3106
- /**
3107
- * SEO slug.
2896
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2897
+ * @minLength 3
3108
2898
  * @maxLength 100
3109
2899
  */
3110
- seoSlug?: string | null;
3111
- /** Post cover media. */
3112
- media?: Media;
3113
- /** Number of paragraphs to display in a paid content preview for non-paying users. */
3114
- previewTextParagraph?: number | null;
2900
+ timeZone?: string | null;
3115
2901
  }
3116
- declare enum Origin {
2902
+ declare enum Order {
3117
2903
  UNKNOWN = "UNKNOWN",
3118
- /** Changed by admin */
3119
- ADMIN = "ADMIN",
3120
- /** Categories were changed */
3121
- ADD_CATEGORIES = "ADD_CATEGORIES",
3122
- /** Saved automatically */
3123
- AUTO_SAVE = "AUTO_SAVE",
3124
- /** Copied from template */
3125
- COPY_TEMPLATE = "COPY_TEMPLATE",
3126
- /** Imported */
3127
- IMPORT = "IMPORT",
3128
- /** Imported in bulk */
3129
- IMPORT_BULK = "IMPORT_BULK",
3130
- /** Imported with html import */
3131
- IMPORT_HTML = "IMPORT_HTML",
3132
- /** Patch import */
3133
- IMPORT_PATCH = "IMPORT_PATCH",
3134
- /** Changed language */
3135
- LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
3136
- /** Saved manually */
3137
- MANUAL_SAVE = "MANUAL_SAVE",
3138
- /** Affected by migration */
3139
- MIGRATION = "MIGRATION",
3140
- /** Affected by moderation */
3141
- MODERATION = "MODERATION",
3142
- /** Moved to trash */
3143
- MOVE_TO_TRASH = "MOVE_TO_TRASH",
3144
- /** Pricing plans were changed */
3145
- PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
3146
- /** Was provisioned */
3147
- PROVISION = "PROVISION",
3148
- /** Was published */
3149
- PUBLISH = "PUBLISH",
3150
- /** Owner was reassigned */
3151
- REASSIGN_OWNER = "REASSIGN_OWNER",
3152
- /** Was reblogged */
3153
- REBLOG = "REBLOG",
3154
- /** Was restored */
3155
- RESTORE = "RESTORE",
3156
- /** Reverted to draft */
3157
- REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
3158
- /** Was translated */
3159
- TRANSLATION = "TRANSLATION",
3160
- /** Was unpublished */
3161
- UNPUBLISH = "UNPUBLISH",
3162
- /** Was unscheduled */
3163
- UNSCHEDULE = "UNSCHEDULE",
3164
- /** New edit session started which updated editing_session_id id */
3165
- NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
3166
- /** Was scheduled by Later */
3167
- SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
3168
- /** Was unscheduled by Later */
3169
- SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
3170
- /** Was published by Later */
3171
- SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
3172
- /** Was scheduled */
3173
- SCHEDULE = "SCHEDULE",
3174
- /** Was removed from moderation */
3175
- REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
3176
- /** Was rejected from moderation */
3177
- REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
3178
- /** Was approved in moderation */
3179
- APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
3180
- /** Tag was deleted */
3181
- DELETE_TAG = "DELETE_TAG",
3182
- /** Post was pinned */
3183
- PIN = "PIN",
3184
- /** Post was unpinned */
3185
- UNPIN = "UNPIN",
3186
- /** Saved automatically by AI tool. */
3187
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
2904
+ OLDEST = "OLDEST",
2905
+ NEWEST = "NEWEST"
3188
2906
  }
3189
2907
  /** @enumType */
3190
- 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';
3191
- declare enum Status {
3192
- UNKNOWN = "UNKNOWN",
3193
- /** Status indicating the draft post is published. */
3194
- PUBLISHED = "PUBLISHED",
3195
- /** Status indicating the draft post is unpublished. */
3196
- UNPUBLISHED = "UNPUBLISHED",
3197
- /** Status indicating the draft post is scheduled for publication. */
3198
- SCHEDULED = "SCHEDULED",
3199
- /** Status indicating the draft post is deleted. */
3200
- DELETED = "DELETED",
3201
- /** Status indicating the draft post is in review. */
3202
- IN_REVIEW = "IN_REVIEW"
2908
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2909
+ /** Get Blog Post Count Stats response */
2910
+ interface QueryPostCountStatsResponse {
2911
+ /** List of published post counts by month. */
2912
+ stats?: PeriodPostCount[];
3203
2913
  }
3204
- /** @enumType */
3205
- type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
3206
- interface DraftPostTranslation {
3207
- /**
3208
- * Post ID.
3209
- * @format GUID
3210
- */
3211
- _id?: string;
3212
- /** Post status. */
3213
- status?: StatusWithLiterals;
2914
+ /** Post count for a specific time period */
2915
+ interface PeriodPostCount {
2916
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2917
+ periodStart?: Date | null;
2918
+ /** Number of posts published during this month. */
2919
+ postCount?: number;
2920
+ }
2921
+ interface GetTotalPublicationsRequest {
3214
2922
  /**
3215
- * Language the post is written in.
2923
+ * Language filter
2924
+ * @minLength 2
3216
2925
  * @format LANGUAGE_TAG
3217
2926
  */
3218
2927
  language?: string | null;
2928
+ }
2929
+ interface GetTotalPublicationsResponse {
2930
+ /** Total amount of publications. */
2931
+ total?: number;
2932
+ }
2933
+ interface GetTotalPostsRequest {
3219
2934
  /**
3220
- * Post slug. For example, 'post-slug'.
3221
- * @maxLength 100
2935
+ * Language filter.
2936
+ *
2937
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2938
+ * Pass a language to receive the total amount of posts in that specified language.
2939
+ * @format LANGUAGE_TAG
3222
2940
  */
3223
- slug?: string | null;
3224
- /** SEO data. */
3225
- seoData?: SeoSchema;
3226
- /** Post URL. */
3227
- url?: string;
2941
+ language?: string | null;
2942
+ }
2943
+ interface GetTotalPostsResponse {
2944
+ /** Total amount of published posts. */
2945
+ total?: number;
3228
2946
  }
3229
2947
  interface DomainEvent extends DomainEventBodyOneOf {
3230
2948
  createdEvent?: EntityCreatedEvent;
@@ -3255,7 +2973,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
3255
2973
  /** If present, indicates the action that triggered the event. */
3256
2974
  originatedFrom?: string | null;
3257
2975
  /**
3258
- * 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.
2976
+ * 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.
3259
2977
  * 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.
3260
2978
  */
3261
2979
  entityEventSequence?: string | null;
@@ -3379,126 +3097,6 @@ interface AccountInfo {
3379
3097
  */
3380
3098
  siteId?: string | null;
3381
3099
  }
3382
- /** Get Blog Publications Count Stats request */
3383
- interface QueryPublicationsCountStatsRequest {
3384
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3385
- rangeStart?: Date | null;
3386
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3387
- rangeEnd?: Date | null;
3388
- /** Order of the returned results. */
3389
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3390
- /** Number of months to include in the response. */
3391
- months?: number;
3392
- /**
3393
- * Language filter
3394
- *
3395
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3396
- * @format LANGUAGE_TAG
3397
- */
3398
- language?: string | null;
3399
- /**
3400
- * Timezone of the client.
3401
- * @minLength 3
3402
- * @maxLength 100
3403
- */
3404
- timeZone?: string | null;
3405
- }
3406
- declare enum QueryPublicationsCountStatsRequestOrder {
3407
- UNKNOWN = "UNKNOWN",
3408
- OLDEST = "OLDEST",
3409
- NEWEST = "NEWEST"
3410
- }
3411
- /** @enumType */
3412
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3413
- /** Get Blog Publications Count Stats response */
3414
- interface QueryPublicationsCountStatsResponse {
3415
- /** Chronologically ordered list of publications. */
3416
- stats?: PeriodPublicationsCount[];
3417
- }
3418
- /** Publications count for a specific time period */
3419
- interface PeriodPublicationsCount {
3420
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3421
- periodStart?: Date | null;
3422
- /** Number of posts published during this month. */
3423
- publicationsCount?: number;
3424
- }
3425
- /** Get Blog Post Count Stats request */
3426
- interface QueryPostCountStatsRequest {
3427
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3428
- rangeStart?: Date | null;
3429
- /**
3430
- * Order of returned results.
3431
- *
3432
- * - `OLDEST`: posts by date in ascending order.
3433
- * - `NEWEST`: posts by date in descending order.
3434
- *
3435
- * Default: `OLDEST`
3436
- */
3437
- order?: OrderWithLiterals;
3438
- /** Number of months to include in response. */
3439
- months?: number;
3440
- /**
3441
- * Language filter.
3442
- *
3443
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3444
- * Pass a language to only receive the period post count for that specified language.
3445
- * @format LANGUAGE_TAG
3446
- */
3447
- language?: string | null;
3448
- /**
3449
- * Time zone to use when calculating the start of the month.
3450
- *
3451
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3452
- * @minLength 3
3453
- * @maxLength 100
3454
- */
3455
- timeZone?: string | null;
3456
- }
3457
- declare enum Order {
3458
- UNKNOWN = "UNKNOWN",
3459
- OLDEST = "OLDEST",
3460
- NEWEST = "NEWEST"
3461
- }
3462
- /** @enumType */
3463
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3464
- /** Get Blog Post Count Stats response */
3465
- interface QueryPostCountStatsResponse {
3466
- /** List of published post counts by month. */
3467
- stats?: PeriodPostCount[];
3468
- }
3469
- /** Post count for a specific time period */
3470
- interface PeriodPostCount {
3471
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3472
- periodStart?: Date | null;
3473
- /** Number of posts published during this month. */
3474
- postCount?: number;
3475
- }
3476
- interface GetTotalPublicationsRequest {
3477
- /**
3478
- * Language filter
3479
- * @minLength 2
3480
- * @format LANGUAGE_TAG
3481
- */
3482
- language?: string | null;
3483
- }
3484
- interface GetTotalPublicationsResponse {
3485
- /** Total amount of publications. */
3486
- total?: number;
3487
- }
3488
- interface GetTotalPostsRequest {
3489
- /**
3490
- * Language filter.
3491
- *
3492
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3493
- * Pass a language to receive the total amount of posts in that specified language.
3494
- * @format LANGUAGE_TAG
3495
- */
3496
- language?: string | null;
3497
- }
3498
- interface GetTotalPostsResponse {
3499
- /** Total amount of published posts. */
3500
- total?: number;
3501
- }
3502
3100
  interface GetTotalLikesPerMemberRequest {
3503
3101
  /**
3504
3102
  * Member ID.
@@ -3708,12 +3306,48 @@ declare enum GetPostsSort {
3708
3306
  }
3709
3307
  /** @enumType */
3710
3308
  type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3309
+ interface BlogPaging {
3310
+ /**
3311
+ * Number of items to skip in the current sort order.
3312
+ *
3313
+ *
3314
+ * Default: `0`
3315
+ */
3316
+ offset?: number;
3317
+ /**
3318
+ * Number of items to return.
3319
+ *
3320
+ *
3321
+ * Default:`50`
3322
+ * @min 1
3323
+ * @max 100
3324
+ */
3325
+ limit?: number;
3326
+ /**
3327
+ * Pointer to the next or previous page in the list of results.
3328
+ * @maxLength 2000
3329
+ */
3330
+ cursor?: string | null;
3331
+ }
3711
3332
  interface ListPostsResponse {
3712
3333
  /** List of retrieved posts. */
3713
3334
  posts?: Post[];
3714
3335
  /** Details on the paged set of results returned. */
3715
3336
  metaData?: MetaData;
3716
3337
  }
3338
+ interface MetaData {
3339
+ /** Number of items returned in this response. */
3340
+ count?: number;
3341
+ /** Requested offset. */
3342
+ offset?: number;
3343
+ /** Total number of items that match the query. */
3344
+ total?: number;
3345
+ /**
3346
+ * Pointer to the next or previous page in the list of results.
3347
+ * @maxLength 2000
3348
+ */
3349
+ cursor?: string | null;
3350
+ }
3717
3351
  interface QueryPostsRequest {
3718
3352
  /** Query options. */
3719
3353
  query?: PlatformQuery;
@@ -4213,7 +3847,7 @@ interface EventMetadata extends BaseEventMetadata {
4213
3847
  /** If present, indicates the action that triggered the event. */
4214
3848
  originatedFrom?: string | null;
4215
3849
  /**
4216
- * 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.
3850
+ * 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.
4217
3851
  * 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.
4218
3852
  */
4219
3853
  entityEventSequence?: string | null;
@@ -4319,13 +3953,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
4319
3953
  /**
4320
3954
  * Retrieves the number of published posts per month within a specified time range.
4321
3955
  *
4322
- * The time range is set using the `rangeStart` and `months` properties.
4323
- * The time range always starts on the 1st day of the month set in `rangeStart` and
4324
- * includes the number of `months` following `rangeStart`.
4325
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
4326
- * 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.
4327
- * > 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.
3956
+ *
3957
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
3958
+ *
3959
+ * 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.
3960
+ *
3961
+ * >**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.
4328
3962
  * @public
3963
+ * @param options - Options specifying time frame, sort, and filter.
4329
3964
  * @permissionId BLOG.READ-PUBLICATION
4330
3965
  * @applicableIdentity APP
4331
3966
  * @returns Get Blog Post Count Stats response
@@ -4366,6 +4001,7 @@ interface QueryPostCountStatsOptions {
4366
4001
  /**
4367
4002
  * Retrieves the total amount of published posts of the blog.
4368
4003
  * @public
4004
+ * @param options - Language Options.
4369
4005
  * @permissionId BLOG.READ-PUBLICATION
4370
4006
  * @applicableIdentity APP
4371
4007
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -4386,12 +4022,12 @@ interface GetTotalPostsOptions {
4386
4022
  * @param postId - Post ID.
4387
4023
  * @public
4388
4024
  * @requiredField postId
4025
+ * @param options - Options specifying which fields to return.
4389
4026
  * @permissionId BLOG.READ-PUBLICATION
4390
4027
  * @applicableIdentity APP
4391
- * @returns Retrieved post info.
4392
4028
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
4393
4029
  */
4394
- 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>>;
4030
+ 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>>;
4395
4031
  interface GetPostOptions {
4396
4032
  /**
4397
4033
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4411,6 +4047,7 @@ interface GetPostOptions {
4411
4047
  * @param slug - Slug of the post to retrieve.
4412
4048
  * @public
4413
4049
  * @requiredField slug
4050
+ * @param options - Options specifying which fields to return.
4414
4051
  * @permissionId BLOG.READ-PUBLICATION
4415
4052
  * @applicableIdentity APP
4416
4053
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -4438,6 +4075,7 @@ interface GetPostBySlugOptions {
4438
4075
  * - `paging.limit` is `50`.
4439
4076
  * - `paging.offset` is `0`.
4440
4077
  * @public
4078
+ * @param options - Sort, filter, and paging options.
4441
4079
  * @permissionId BLOG.READ-PUBLICATION
4442
4080
  * @applicableIdentity APP
4443
4081
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -4508,18 +4146,26 @@ interface ListPostsOptions {
4508
4146
  fieldsets?: PostFieldFieldWithLiterals[];
4509
4147
  }
4510
4148
  /**
4511
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
4149
+ * Creates a query to retrieve a list of posts.
4512
4150
  *
4513
- * Query Posts runs with these defaults, which you can override:
4514
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
4515
- * - `paging.limit` is `50`.
4516
- * - `paging.offset` is `0`.
4517
4151
  *
4518
- * To learn about working with _Query_ endpoints, see
4519
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
4520
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
4521
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
4152
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
4153
+ *
4154
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
4155
+ *
4156
+ * 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.
4157
+ *
4158
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
4159
+ * + `limit(50)`
4160
+ * + `descending('firstPublishedDate')`
4161
+ *
4162
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
4163
+ *
4164
+ * To learn how to query posts, refer to the table below.
4165
+ *
4166
+ * 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`.
4522
4167
  * @public
4168
+ * @param options - Options specifying which fields to return.
4523
4169
  * @permissionId BLOG.READ-PUBLICATION
4524
4170
  * @applicableIdentity APP
4525
4171
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
@@ -4769,7 +4415,7 @@ declare const utils: {
4769
4415
  query: {
4770
4416
  QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4771
4417
  Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4772
- Sort: _wix_sdk_types.SortFactory<PostQuerySpec>; /** Data for a color decoration. */
4418
+ Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
4773
4419
  };
4774
4420
  };
4775
4421
  /**
@@ -4785,4 +4431,4 @@ declare const utils: {
4785
4431
  */
4786
4432
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4787
4433
 
4788
- 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 };
4434
+ 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 };