@wix/auto_sdk_blog_posts 1.0.143 → 1.0.145

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 +54 -49
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +546 -543
  5. package/build/cjs/index.typings.js +44 -44
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +399 -399
  8. package/build/cjs/meta.js +38 -38
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +86 -88
  11. package/build/cjs/schemas.js +153 -151
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +15 -11
  14. package/build/es/index.mjs +54 -49
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +546 -543
  17. package/build/es/index.typings.mjs +44 -44
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +399 -399
  20. package/build/es/meta.mjs +38 -38
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +86 -88
  23. package/build/es/schemas.mjs +153 -151
  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 +54 -49
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +546 -543
  29. package/build/internal/cjs/index.typings.js +44 -44
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +399 -399
  32. package/build/internal/cjs/meta.js +38 -38
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +86 -88
  35. package/build/internal/cjs/schemas.js +153 -151
  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 +54 -49
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +546 -543
  41. package/build/internal/es/index.typings.mjs +44 -44
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +399 -399
  44. package/build/internal/es/meta.mjs +38 -38
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +86 -88
  47. package/build/internal/es/schemas.mjs +153 -151
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -2640,454 +2640,170 @@ interface PostUnlikedInitiatorOneOf {
2640
2640
  */
2641
2641
  anonymousVisitorId?: string | null;
2642
2642
  }
2643
- interface GetTotalLikesPerMemberRequest {
2643
+ interface ListTemplatesRequest {
2644
2644
  /**
2645
- * Member ID.
2645
+ * Filter post templates by given template category ids
2646
+ * @maxSize 50
2646
2647
  * @format GUID
2647
2648
  */
2648
- memberId?: string;
2649
- }
2650
- interface GetTotalLikesPerMemberResponse {
2651
- /** The total number of likes of the member. */
2652
- total?: number;
2653
- }
2654
- interface DomainEvent extends DomainEventBodyOneOf {
2655
- createdEvent?: EntityCreatedEvent;
2656
- updatedEvent?: EntityUpdatedEvent;
2657
- deletedEvent?: EntityDeletedEvent;
2658
- actionEvent?: ActionEvent;
2659
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2660
- _id?: string;
2649
+ categoryIds?: string[];
2661
2650
  /**
2662
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2663
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2651
+ * Filter post templates by provided language
2652
+ * @format LANGUAGE_TAG
2664
2653
  */
2665
- entityFqdn?: string;
2654
+ language?: string | null;
2655
+ /** Returns post template categories when set to TRUE */
2656
+ listTemplateCategories?: boolean;
2657
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2658
+ sort?: GetPostTemplatesSortWithLiterals;
2659
+ /** Pagination options. */
2660
+ paging?: BlogPaging;
2661
+ }
2662
+ declare enum GetPostTemplatesSort {
2663
+ /** Sort by ascending publishing date. */
2664
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2665
+ /** Sort by descending publishing date. */
2666
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2667
+ }
2668
+ /** @enumType */
2669
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2670
+ interface BlogPaging {
2666
2671
  /**
2667
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2668
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2672
+ * Number of items to skip in the current sort order.
2673
+ *
2674
+ *
2675
+ * Default: `0`
2669
2676
  */
2670
- slug?: string;
2671
- /** ID of the entity associated with the event. */
2672
- entityId?: string;
2673
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2674
- eventTime?: Date | null;
2677
+ offset?: number;
2675
2678
  /**
2676
- * Whether the event was triggered as a result of a privacy regulation application
2677
- * (for example, GDPR).
2679
+ * Number of items to return.
2680
+ *
2681
+ *
2682
+ * Default:`50`
2683
+ * @min 1
2684
+ * @max 100
2678
2685
  */
2679
- triggeredByAnonymizeRequest?: boolean | null;
2680
- /** If present, indicates the action that triggered the event. */
2681
- originatedFrom?: string | null;
2686
+ limit?: number;
2682
2687
  /**
2683
- * 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.
2684
- * 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.
2688
+ * Pointer to the next or previous page in the list of results.
2689
+ * @maxLength 2000
2685
2690
  */
2686
- entityEventSequence?: string | null;
2687
- }
2688
- /** @oneof */
2689
- interface DomainEventBodyOneOf {
2690
- createdEvent?: EntityCreatedEvent;
2691
- updatedEvent?: EntityUpdatedEvent;
2692
- deletedEvent?: EntityDeletedEvent;
2693
- actionEvent?: ActionEvent;
2694
- }
2695
- interface EntityCreatedEvent {
2696
- entity?: string;
2691
+ cursor?: string | null;
2697
2692
  }
2698
- interface RestoreInfo {
2699
- deletedDate?: Date | null;
2693
+ interface ListTemplatesResponse {
2694
+ /** Available post templates */
2695
+ postTemplates?: Post[];
2696
+ /** Details on the paged set of posts templates returned. */
2697
+ postTemplatesMetaData?: MetaData;
2698
+ /** Post template categories. This value is returned empty unless asked explicitly */
2699
+ templateCategories?: Category[];
2700
2700
  }
2701
- interface EntityUpdatedEvent {
2701
+ interface MetaData {
2702
+ /** Number of items returned in this response. */
2703
+ count?: number;
2704
+ /** Requested offset. */
2705
+ offset?: number;
2706
+ /** Total number of items that match the query. */
2707
+ total?: number;
2702
2708
  /**
2703
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2704
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2705
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2709
+ * Pointer to the next or previous page in the list of results.
2710
+ * @maxLength 2000
2706
2711
  */
2707
- currentEntity?: string;
2708
- }
2709
- interface EntityDeletedEvent {
2710
- /** Entity that was deleted. */
2711
- deletedEntity?: string | null;
2712
- }
2713
- interface ActionEvent {
2714
- body?: string;
2712
+ cursor?: string | null;
2715
2713
  }
2716
- interface MessageEnvelope {
2714
+ interface Category {
2717
2715
  /**
2718
- * App instance ID.
2719
- * @format GUID
2716
+ * Category ID.
2717
+ * @immutable
2718
+ * @maxLength 38
2720
2719
  */
2721
- instanceId?: string | null;
2720
+ _id?: string;
2722
2721
  /**
2723
- * Event type.
2724
- * @maxLength 150
2722
+ * Category label. Displayed in the Category Menu.
2723
+ * @maxLength 35
2725
2724
  */
2726
- eventType?: string;
2727
- /** The identification type and identity data. */
2728
- identity?: IdentificationData;
2729
- /** Stringify payload. */
2730
- data?: string;
2731
- /** Details related to the account */
2732
- accountInfo?: AccountInfo;
2733
- }
2734
- interface IdentificationData extends IdentificationDataIdOneOf {
2725
+ label?: string;
2735
2726
  /**
2736
- * ID of a site visitor that has not logged in to the site.
2737
- * @format GUID
2727
+ * Number of posts in the category.
2728
+ * @readonly
2738
2729
  */
2739
- anonymousVisitorId?: string;
2730
+ postCount?: number;
2740
2731
  /**
2741
- * ID of a site visitor that has logged in to the site.
2742
- * @format GUID
2732
+ * The `url` of the page that lists every post with the specified category.
2733
+ * @readonly
2743
2734
  */
2744
- memberId?: string;
2735
+ url?: string;
2745
2736
  /**
2746
- * ID of a Wix user (site owner, contributor, etc.).
2747
- * @format GUID
2737
+ * Category description.
2738
+ * @maxLength 500
2748
2739
  */
2749
- wixUserId?: string;
2740
+ description?: string | null;
2750
2741
  /**
2751
- * ID of an app.
2752
- * @format GUID
2742
+ * Category title.
2743
+ * @maxLength 200
2744
+ * @deprecated Category title.
2745
+ * @targetRemovalDate 2025-07-16
2753
2746
  */
2754
- appId?: string;
2755
- /** @readonly */
2756
- identityType?: WebhookIdentityTypeWithLiterals;
2757
- }
2758
- /** @oneof */
2759
- interface IdentificationDataIdOneOf {
2747
+ title?: string;
2760
2748
  /**
2761
- * ID of a site visitor that has not logged in to the site.
2762
- * @format GUID
2749
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2750
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2751
+ *
2752
+ * Default: `-1`
2763
2753
  */
2764
- anonymousVisitorId?: string;
2754
+ displayPosition?: number | null;
2765
2755
  /**
2766
- * ID of a site visitor that has logged in to the site.
2756
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2767
2757
  * @format GUID
2768
2758
  */
2769
- memberId?: string;
2759
+ translationId?: string | null;
2770
2760
  /**
2771
- * ID of a Wix user (site owner, contributor, etc.).
2772
- * @format GUID
2761
+ * Category language.
2762
+ *
2763
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2764
+ * @immutable
2773
2765
  */
2774
- wixUserId?: string;
2766
+ language?: string | null;
2775
2767
  /**
2776
- * ID of an app.
2777
- * @format GUID
2768
+ * 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`.
2769
+ * @maxLength 100
2778
2770
  */
2779
- appId?: string;
2780
- }
2781
- declare enum WebhookIdentityType {
2782
- UNKNOWN = "UNKNOWN",
2783
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2784
- MEMBER = "MEMBER",
2785
- WIX_USER = "WIX_USER",
2786
- APP = "APP"
2787
- }
2788
- /** @enumType */
2789
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2790
- interface AccountInfo {
2771
+ slug?: string;
2772
+ /** SEO data. */
2773
+ seoData?: SeoSchema;
2774
+ /** Category cover image. */
2775
+ coverImage?: string;
2791
2776
  /**
2792
- * ID of the Wix account associated with the event.
2793
- * @format GUID
2777
+ * Date and time the Category was last updated.
2778
+ * @readonly
2794
2779
  */
2795
- accountId?: string | null;
2780
+ _updatedDate?: Date | null;
2781
+ }
2782
+ interface CategoryTranslation {
2796
2783
  /**
2797
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2784
+ * Category ID.
2798
2785
  * @format GUID
2799
2786
  */
2800
- parentAccountId?: string | null;
2787
+ _id?: string;
2801
2788
  /**
2802
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2803
- * @format GUID
2789
+ * Label displayed in the categories menu on the site.
2790
+ * @maxLength 100
2804
2791
  */
2805
- siteId?: string | null;
2806
- }
2807
- /** Get Blog Publications Count Stats request */
2808
- interface QueryPublicationsCountStatsRequest {
2809
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2810
- rangeStart?: Date | null;
2811
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2812
- rangeEnd?: Date | null;
2813
- /** Order of the returned results. */
2814
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2815
- /** Number of months to include in the response. */
2816
- months?: number;
2792
+ label?: string | null;
2817
2793
  /**
2818
- * Language filter
2819
- *
2820
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2794
+ * Language of the category.
2821
2795
  * @format LANGUAGE_TAG
2822
2796
  */
2823
2797
  language?: string | null;
2798
+ /** URL of this category page. */
2799
+ url?: string;
2800
+ }
2801
+ interface GetTemplateRequest {
2824
2802
  /**
2825
- * Timezone of the client.
2826
- * @minLength 3
2827
- * @maxLength 100
2803
+ * Post template id
2804
+ * @format GUID
2828
2805
  */
2829
- timeZone?: string | null;
2830
- }
2831
- declare enum QueryPublicationsCountStatsRequestOrder {
2832
- UNKNOWN = "UNKNOWN",
2833
- OLDEST = "OLDEST",
2834
- NEWEST = "NEWEST"
2835
- }
2836
- /** @enumType */
2837
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2838
- /** Get Blog Publications Count Stats response */
2839
- interface QueryPublicationsCountStatsResponse {
2840
- /** Chronologically ordered list of publications. */
2841
- stats?: PeriodPublicationsCount[];
2842
- }
2843
- /** Publications count for a specific time period */
2844
- interface PeriodPublicationsCount {
2845
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2846
- periodStart?: Date | null;
2847
- /** Number of posts published during this month. */
2848
- publicationsCount?: number;
2849
- }
2850
- /** Get Blog Post Count Stats request */
2851
- interface QueryPostCountStatsRequest {
2852
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2853
- rangeStart?: Date | null;
2854
- /**
2855
- * Order of returned results.
2856
- *
2857
- * - `OLDEST`: posts by date in ascending order.
2858
- * - `NEWEST`: posts by date in descending order.
2859
- *
2860
- * Default: `OLDEST`
2861
- */
2862
- order?: OrderWithLiterals;
2863
- /** Number of months to include in response. */
2864
- months?: number;
2865
- /**
2866
- * Language filter.
2867
- *
2868
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2869
- * Pass a language to only receive the period post count for that specified language.
2870
- * @format LANGUAGE_TAG
2871
- */
2872
- language?: string | null;
2873
- /**
2874
- * Time zone to use when calculating the start of the month.
2875
- *
2876
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2877
- * @minLength 3
2878
- * @maxLength 100
2879
- */
2880
- timeZone?: string | null;
2881
- }
2882
- declare enum Order {
2883
- UNKNOWN = "UNKNOWN",
2884
- OLDEST = "OLDEST",
2885
- NEWEST = "NEWEST"
2886
- }
2887
- /** @enumType */
2888
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2889
- /** Get Blog Post Count Stats response */
2890
- interface QueryPostCountStatsResponse {
2891
- /** List of published post counts by month. */
2892
- stats?: PeriodPostCount[];
2893
- }
2894
- /** Post count for a specific time period */
2895
- interface PeriodPostCount {
2896
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2897
- periodStart?: Date | null;
2898
- /** Number of posts published during this month. */
2899
- postCount?: number;
2900
- }
2901
- interface GetTotalPublicationsRequest {
2902
- /**
2903
- * Language filter
2904
- * @minLength 2
2905
- * @format LANGUAGE_TAG
2906
- */
2907
- language?: string | null;
2908
- }
2909
- interface GetTotalPublicationsResponse {
2910
- /** Total amount of publications. */
2911
- total?: number;
2912
- }
2913
- interface GetTotalPostsRequest {
2914
- /**
2915
- * Language filter.
2916
- *
2917
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2918
- * Pass a language to receive the total amount of posts in that specified language.
2919
- * @format LANGUAGE_TAG
2920
- */
2921
- language?: string | null;
2922
- }
2923
- interface GetTotalPostsResponse {
2924
- /** Total amount of published posts. */
2925
- total?: number;
2926
- }
2927
- interface ListTemplatesRequest {
2928
- /**
2929
- * Filter post templates by given template category ids
2930
- * @maxSize 50
2931
- * @format GUID
2932
- */
2933
- categoryIds?: string[];
2934
- /**
2935
- * Filter post templates by provided language
2936
- * @format LANGUAGE_TAG
2937
- */
2938
- language?: string | null;
2939
- /** Returns post template categories when set to TRUE */
2940
- listTemplateCategories?: boolean;
2941
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2942
- sort?: GetPostTemplatesSortWithLiterals;
2943
- /** Pagination options. */
2944
- paging?: BlogPaging;
2945
- }
2946
- declare enum GetPostTemplatesSort {
2947
- /** Sort by ascending publishing date. */
2948
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2949
- /** Sort by descending publishing date. */
2950
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2951
- }
2952
- /** @enumType */
2953
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2954
- interface BlogPaging {
2955
- /**
2956
- * Number of items to skip in the current sort order.
2957
- *
2958
- *
2959
- * Default: `0`
2960
- */
2961
- offset?: number;
2962
- /**
2963
- * Number of items to return.
2964
- *
2965
- *
2966
- * Default:`50`
2967
- * @min 1
2968
- * @max 100
2969
- */
2970
- limit?: number;
2971
- /**
2972
- * Pointer to the next or previous page in the list of results.
2973
- * @maxLength 2000
2974
- */
2975
- cursor?: string | null;
2976
- }
2977
- interface ListTemplatesResponse {
2978
- /** Available post templates */
2979
- postTemplates?: Post[];
2980
- /** Details on the paged set of posts templates returned. */
2981
- postTemplatesMetaData?: MetaData;
2982
- /** Post template categories. This value is returned empty unless asked explicitly */
2983
- templateCategories?: Category[];
2984
- }
2985
- interface MetaData {
2986
- /** Number of items returned in this response. */
2987
- count?: number;
2988
- /** Requested offset. */
2989
- offset?: number;
2990
- /** Total number of items that match the query. */
2991
- total?: number;
2992
- /**
2993
- * Pointer to the next or previous page in the list of results.
2994
- * @maxLength 2000
2995
- */
2996
- cursor?: string | null;
2997
- }
2998
- interface Category {
2999
- /**
3000
- * Category ID.
3001
- * @immutable
3002
- * @maxLength 38
3003
- */
3004
- _id?: string;
3005
- /**
3006
- * Category label. Displayed in the Category Menu.
3007
- * @maxLength 35
3008
- */
3009
- label?: string;
3010
- /**
3011
- * Number of posts in the category.
3012
- * @readonly
3013
- */
3014
- postCount?: number;
3015
- /**
3016
- * The `url` of the page that lists every post with the specified category.
3017
- * @readonly
3018
- */
3019
- url?: string;
3020
- /**
3021
- * Category description.
3022
- * @maxLength 500
3023
- */
3024
- description?: string | null;
3025
- /**
3026
- * Category title.
3027
- * @maxLength 200
3028
- * @deprecated Category title.
3029
- * @targetRemovalDate 2025-07-16
3030
- */
3031
- title?: string;
3032
- /**
3033
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
3034
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
3035
- *
3036
- * Default: `-1`
3037
- */
3038
- displayPosition?: number | null;
3039
- /**
3040
- * ID of the category's translations. All translations of a single category share the same `translationId`.
3041
- * @format GUID
3042
- */
3043
- translationId?: string | null;
3044
- /**
3045
- * Category language.
3046
- *
3047
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3048
- * @immutable
3049
- */
3050
- language?: string | null;
3051
- /**
3052
- * 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`.
3053
- * @maxLength 100
3054
- */
3055
- slug?: string;
3056
- /** SEO data. */
3057
- seoData?: SeoSchema;
3058
- /** Category cover image. */
3059
- coverImage?: string;
3060
- /**
3061
- * Date and time the Category was last updated.
3062
- * @readonly
3063
- */
3064
- _updatedDate?: Date | null;
3065
- }
3066
- interface CategoryTranslation {
3067
- /**
3068
- * Category ID.
3069
- * @format GUID
3070
- */
3071
- _id?: string;
3072
- /**
3073
- * Label displayed in the categories menu on the site.
3074
- * @maxLength 100
3075
- */
3076
- label?: string | null;
3077
- /**
3078
- * Language of the category.
3079
- * @format LANGUAGE_TAG
3080
- */
3081
- language?: string | null;
3082
- /** URL of this category page. */
3083
- url?: string;
3084
- }
3085
- interface GetTemplateRequest {
3086
- /**
3087
- * Post template id
3088
- * @format GUID
3089
- */
3090
- postTemplateId?: string;
2806
+ postTemplateId?: string;
3091
2807
  }
3092
2808
  interface GetTemplateResponse {
3093
2809
  /** Post template */
@@ -3352,157 +3068,289 @@ interface DraftPostTranslation {
3352
3068
  /** Post URL. */
3353
3069
  url?: string;
3354
3070
  }
3355
- interface ListDemoPostsRequest {
3071
+ interface DomainEvent extends DomainEventBodyOneOf {
3072
+ createdEvent?: EntityCreatedEvent;
3073
+ updatedEvent?: EntityUpdatedEvent;
3074
+ deletedEvent?: EntityDeletedEvent;
3075
+ actionEvent?: ActionEvent;
3076
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3077
+ _id?: string;
3356
3078
  /**
3357
- * Whether to return only featured posts.
3358
- *
3359
- * Default: `false`
3079
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3080
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3360
3081
  */
3361
- featured?: boolean;
3082
+ entityFqdn?: string;
3362
3083
  /**
3363
- * Hashtag filter.
3364
- *
3365
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3366
- * If omitted, all posts with or without hashtags are returned.
3367
- * @maxSize 100
3368
- * @maxLength 100
3084
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3085
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3369
3086
  */
3370
- hashtags?: string[];
3087
+ slug?: string;
3088
+ /** ID of the entity associated with the event. */
3089
+ entityId?: string;
3090
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3091
+ eventTime?: Date | null;
3371
3092
  /**
3372
- * Category filter.
3373
- *
3374
- * Pass an array of category IDs to return only posts with any of the provided categories.
3375
- * If omitted, all posts with or without associated categories are returned.
3376
- * @maxSize 50
3093
+ * Whether the event was triggered as a result of a privacy regulation application
3094
+ * (for example, GDPR).
3095
+ */
3096
+ triggeredByAnonymizeRequest?: boolean | null;
3097
+ /** If present, indicates the action that triggered the event. */
3098
+ originatedFrom?: string | null;
3099
+ /**
3100
+ * 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.
3101
+ * 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.
3102
+ */
3103
+ entityEventSequence?: string | null;
3104
+ }
3105
+ /** @oneof */
3106
+ interface DomainEventBodyOneOf {
3107
+ createdEvent?: EntityCreatedEvent;
3108
+ updatedEvent?: EntityUpdatedEvent;
3109
+ deletedEvent?: EntityDeletedEvent;
3110
+ actionEvent?: ActionEvent;
3111
+ }
3112
+ interface EntityCreatedEvent {
3113
+ entity?: string;
3114
+ }
3115
+ interface RestoreInfo {
3116
+ deletedDate?: Date | null;
3117
+ }
3118
+ interface EntityUpdatedEvent {
3119
+ /**
3120
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3121
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3122
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3123
+ */
3124
+ currentEntity?: string;
3125
+ }
3126
+ interface EntityDeletedEvent {
3127
+ /** Entity that was deleted. */
3128
+ deletedEntity?: string | null;
3129
+ }
3130
+ interface ActionEvent {
3131
+ body?: string;
3132
+ }
3133
+ interface MessageEnvelope {
3134
+ /**
3135
+ * App instance ID.
3377
3136
  * @format GUID
3378
3137
  */
3379
- categoryIds?: string[];
3138
+ instanceId?: string | null;
3380
3139
  /**
3381
- * Tag filter.
3382
- *
3383
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3384
- * If omitted, all posts with or without tags are returned.
3385
- * @maxSize 50
3140
+ * Event type.
3141
+ * @maxLength 150
3142
+ */
3143
+ eventType?: string;
3144
+ /** The identification type and identity data. */
3145
+ identity?: IdentificationData;
3146
+ /** Stringify payload. */
3147
+ data?: string;
3148
+ /** Details related to the account */
3149
+ accountInfo?: AccountInfo;
3150
+ }
3151
+ interface IdentificationData extends IdentificationDataIdOneOf {
3152
+ /**
3153
+ * ID of a site visitor that has not logged in to the site.
3386
3154
  * @format GUID
3387
3155
  */
3388
- tagIds?: string[];
3156
+ anonymousVisitorId?: string;
3389
3157
  /**
3390
- * Sorting options.
3391
- *
3392
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3393
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3394
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3395
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3396
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3397
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3398
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3399
- * - `RATING`: reserved for internal use.
3158
+ * ID of a site visitor that has logged in to the site.
3159
+ * @format GUID
3160
+ */
3161
+ memberId?: string;
3162
+ /**
3163
+ * ID of a Wix user (site owner, contributor, etc.).
3164
+ * @format GUID
3165
+ */
3166
+ wixUserId?: string;
3167
+ /**
3168
+ * ID of an app.
3169
+ * @format GUID
3170
+ */
3171
+ appId?: string;
3172
+ /** @readonly */
3173
+ identityType?: WebhookIdentityTypeWithLiterals;
3174
+ }
3175
+ /** @oneof */
3176
+ interface IdentificationDataIdOneOf {
3177
+ /**
3178
+ * ID of a site visitor that has not logged in to the site.
3179
+ * @format GUID
3180
+ */
3181
+ anonymousVisitorId?: string;
3182
+ /**
3183
+ * ID of a site visitor that has logged in to the site.
3184
+ * @format GUID
3185
+ */
3186
+ memberId?: string;
3187
+ /**
3188
+ * ID of a Wix user (site owner, contributor, etc.).
3189
+ * @format GUID
3190
+ */
3191
+ wixUserId?: string;
3192
+ /**
3193
+ * ID of an app.
3194
+ * @format GUID
3195
+ */
3196
+ appId?: string;
3197
+ }
3198
+ declare enum WebhookIdentityType {
3199
+ UNKNOWN = "UNKNOWN",
3200
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3201
+ MEMBER = "MEMBER",
3202
+ WIX_USER = "WIX_USER",
3203
+ APP = "APP"
3204
+ }
3205
+ /** @enumType */
3206
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3207
+ interface AccountInfo {
3208
+ /**
3209
+ * ID of the Wix account associated with the event.
3210
+ * @format GUID
3211
+ */
3212
+ accountId?: string | null;
3213
+ /**
3214
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
3215
+ * @format GUID
3216
+ */
3217
+ parentAccountId?: string | null;
3218
+ /**
3219
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3220
+ * @format GUID
3221
+ */
3222
+ siteId?: string | null;
3223
+ }
3224
+ /** Get Blog Publications Count Stats request */
3225
+ interface QueryPublicationsCountStatsRequest {
3226
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3227
+ rangeStart?: Date | null;
3228
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3229
+ rangeEnd?: Date | null;
3230
+ /** Order of the returned results. */
3231
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3232
+ /** Number of months to include in the response. */
3233
+ months?: number;
3234
+ /**
3235
+ * Language filter
3400
3236
  *
3401
- * Default: `FEED`
3237
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3238
+ * @format LANGUAGE_TAG
3402
3239
  */
3403
- sort?: GetPostsSortWithLiterals;
3404
- /** Pagination options. */
3405
- paging?: BlogPaging;
3240
+ language?: string | null;
3406
3241
  /**
3407
- * __Deprecated.__ Use `fieldsets` instead.
3408
- * This parameter will be removed on June 30, 2023.
3242
+ * Timezone of the client.
3243
+ * @minLength 3
3244
+ * @maxLength 100
3245
+ */
3246
+ timeZone?: string | null;
3247
+ }
3248
+ declare enum QueryPublicationsCountStatsRequestOrder {
3249
+ UNKNOWN = "UNKNOWN",
3250
+ OLDEST = "OLDEST",
3251
+ NEWEST = "NEWEST"
3252
+ }
3253
+ /** @enumType */
3254
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3255
+ /** Get Blog Publications Count Stats response */
3256
+ interface QueryPublicationsCountStatsResponse {
3257
+ /** Chronologically ordered list of publications. */
3258
+ stats?: PeriodPublicationsCount[];
3259
+ }
3260
+ /** Publications count for a specific time period */
3261
+ interface PeriodPublicationsCount {
3262
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3263
+ periodStart?: Date | null;
3264
+ /** Number of posts published during this month. */
3265
+ publicationsCount?: number;
3266
+ }
3267
+ /** Get Blog Post Count Stats request */
3268
+ interface QueryPostCountStatsRequest {
3269
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3270
+ rangeStart?: Date | null;
3271
+ /**
3272
+ * Order of returned results.
3409
3273
  *
3410
- * List of post fields to be included in the response.
3411
- * @maxSize 20
3412
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
3413
- * This parameter will be removed on June 30, 2023.
3274
+ * - `OLDEST`: posts by date in ascending order.
3275
+ * - `NEWEST`: posts by date in descending order.
3414
3276
  *
3415
- * List of post fields to be included in the response.
3416
- * @replacedBy fieldsets
3417
- * @targetRemovalDate 2024-06-30
3277
+ * Default: `OLDEST`
3418
3278
  */
3419
- fieldsToInclude?: PostFieldFieldWithLiterals[];
3279
+ order?: OrderWithLiterals;
3280
+ /** Number of months to include in response. */
3281
+ months?: number;
3420
3282
  /**
3421
3283
  * Language filter.
3422
3284
  *
3423
3285
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3424
- * Pass a language to only receive posts that are in that language.
3425
- * If omitted, posts in all languages are returned.
3286
+ * Pass a language to only receive the period post count for that specified language.
3426
3287
  * @format LANGUAGE_TAG
3427
3288
  */
3428
3289
  language?: string | null;
3429
3290
  /**
3430
- * Post owner's member ID.
3431
- * @format GUID
3432
- */
3433
- memberId?: string | null;
3434
- /**
3435
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3436
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3437
- * only the post’s base fields are returned.
3438
- * @maxSize 20
3439
- */
3440
- fieldsets?: PostFieldFieldWithLiterals[];
3441
- }
3442
- declare enum GetPostsSort {
3443
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3444
- FEED = "FEED",
3445
- /** Ordered by `firstPublishedDate` in ascending order. */
3446
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3447
- /** Ordered by `firstPublishedDate` in descending order. */
3448
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3449
- /** Ordered by total number of views in descending order. */
3450
- VIEW_COUNT = "VIEW_COUNT",
3451
- /** Ordered by total number of likes in descending order. */
3452
- LIKE_COUNT = "LIKE_COUNT",
3453
- /** Ordered by `title` in ascending order. */
3454
- TITLE_ASC = "TITLE_ASC",
3455
- /** Ordered by `title` in descending order. */
3456
- TITLE_DESC = "TITLE_DESC"
3291
+ * Time zone to use when calculating the start of the month.
3292
+ *
3293
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3294
+ * @minLength 3
3295
+ * @maxLength 100
3296
+ */
3297
+ timeZone?: string | null;
3457
3298
  }
3458
- /** @enumType */
3459
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3460
- declare enum PostFieldField {
3299
+ declare enum Order {
3461
3300
  UNKNOWN = "UNKNOWN",
3462
- /** Includes post URL when present. */
3463
- URL = "URL",
3464
- /** Includes post content text string when present. */
3465
- CONTENT_TEXT = "CONTENT_TEXT",
3466
- /** Includes post metrics when present. */
3467
- METRICS = "METRICS",
3468
- /** Includes SEO data. */
3469
- SEO = "SEO",
3470
- /** Includes post owner's contact ID. */
3471
- CONTACT_ID = "CONTACT_ID",
3472
- /** Includes post rich content. */
3473
- RICH_CONTENT = "RICH_CONTENT",
3474
- /** Includes post reference ID field. */
3475
- REFERENCE_ID = "REFERENCE_ID"
3301
+ OLDEST = "OLDEST",
3302
+ NEWEST = "NEWEST"
3476
3303
  }
3477
3304
  /** @enumType */
3478
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3479
- interface ListDemoPostsResponse {
3480
- /** List of posts. */
3481
- posts?: Post[];
3482
- /** Details on the paged set of results returned. */
3483
- metaData?: MetaData;
3305
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3306
+ /** Get Blog Post Count Stats response */
3307
+ interface QueryPostCountStatsResponse {
3308
+ /** List of published post counts by month. */
3309
+ stats?: PeriodPostCount[];
3484
3310
  }
3485
- interface ConvertDraftJsToRichContentRequest {
3486
- /** DraftJs content to convert to Rich content. */
3487
- content?: Record<string, any> | null;
3311
+ /** Post count for a specific time period */
3312
+ interface PeriodPostCount {
3313
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3314
+ periodStart?: Date | null;
3315
+ /** Number of posts published during this month. */
3316
+ postCount?: number;
3488
3317
  }
3489
- interface ConvertDraftJsToRichContentResponse {
3318
+ interface GetTotalPublicationsRequest {
3490
3319
  /**
3491
- * Rich content converted from DraftJs content.
3492
- * @maxLength 2000000
3320
+ * Language filter
3321
+ * @minLength 2
3322
+ * @format LANGUAGE_TAG
3493
3323
  */
3494
- richContent?: string;
3324
+ language?: string | null;
3495
3325
  }
3496
- interface ConvertRichContentToDraftJsRequest {
3326
+ interface GetTotalPublicationsResponse {
3327
+ /** Total amount of publications. */
3328
+ total?: number;
3329
+ }
3330
+ interface GetTotalPostsRequest {
3497
3331
  /**
3498
- * Rich content to convert to DraftJs content.
3499
- * @maxLength 2000000
3332
+ * Language filter.
3333
+ *
3334
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3335
+ * Pass a language to receive the total amount of posts in that specified language.
3336
+ * @format LANGUAGE_TAG
3500
3337
  */
3501
- richContent?: string;
3338
+ language?: string | null;
3502
3339
  }
3503
- interface ConvertRichContentToDraftJsResponse {
3504
- /** DraftJs content converted from Rich content. */
3505
- content?: Record<string, any> | null;
3340
+ interface GetTotalPostsResponse {
3341
+ /** Total amount of published posts. */
3342
+ total?: number;
3343
+ }
3344
+ interface GetTotalLikesPerMemberRequest {
3345
+ /**
3346
+ * Member ID.
3347
+ * @format GUID
3348
+ */
3349
+ memberId?: string;
3350
+ }
3351
+ interface GetTotalLikesPerMemberResponse {
3352
+ /** The total number of likes of the member. */
3353
+ total?: number;
3506
3354
  }
3507
3355
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3508
3356
  /**
@@ -3573,6 +3421,25 @@ interface GetPostRequest {
3573
3421
  */
3574
3422
  fieldsets?: PostFieldFieldWithLiterals[];
3575
3423
  }
3424
+ declare enum PostFieldField {
3425
+ UNKNOWN = "UNKNOWN",
3426
+ /** Includes post URL when present. */
3427
+ URL = "URL",
3428
+ /** Includes post content text string when present. */
3429
+ CONTENT_TEXT = "CONTENT_TEXT",
3430
+ /** Includes post metrics when present. */
3431
+ METRICS = "METRICS",
3432
+ /** Includes SEO data. */
3433
+ SEO = "SEO",
3434
+ /** Includes post owner's contact ID. */
3435
+ CONTACT_ID = "CONTACT_ID",
3436
+ /** Includes post rich content. */
3437
+ RICH_CONTENT = "RICH_CONTENT",
3438
+ /** Includes post reference ID field. */
3439
+ REFERENCE_ID = "REFERENCE_ID"
3440
+ }
3441
+ /** @enumType */
3442
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3576
3443
  interface GetPostResponse {
3577
3444
  /** Retrieved post info. */
3578
3445
  post?: Post;
@@ -3665,6 +3532,24 @@ interface ListPostsRequest {
3665
3532
  */
3666
3533
  fieldsets?: PostFieldFieldWithLiterals[];
3667
3534
  }
3535
+ declare enum GetPostsSort {
3536
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3537
+ FEED = "FEED",
3538
+ /** Ordered by `firstPublishedDate` in ascending order. */
3539
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3540
+ /** Ordered by `firstPublishedDate` in descending order. */
3541
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3542
+ /** Ordered by total number of views in descending order. */
3543
+ VIEW_COUNT = "VIEW_COUNT",
3544
+ /** Ordered by total number of likes in descending order. */
3545
+ LIKE_COUNT = "LIKE_COUNT",
3546
+ /** Ordered by `title` in ascending order. */
3547
+ TITLE_ASC = "TITLE_ASC",
3548
+ /** Ordered by `title` in descending order. */
3549
+ TITLE_DESC = "TITLE_DESC"
3550
+ }
3551
+ /** @enumType */
3552
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3668
3553
  interface ListPostsResponse {
3669
3554
  /** List of retrieved posts. */
3670
3555
  posts?: Post[];
@@ -4014,6 +3899,121 @@ interface PostCount {
4014
3899
  /** Number of posts. */
4015
3900
  postCount?: number;
4016
3901
  }
3902
+ interface ListDemoPostsRequest {
3903
+ /**
3904
+ * Whether to return only featured posts.
3905
+ *
3906
+ * Default: `false`
3907
+ */
3908
+ featured?: boolean;
3909
+ /**
3910
+ * Hashtag filter.
3911
+ *
3912
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3913
+ * If omitted, all posts with or without hashtags are returned.
3914
+ * @maxSize 100
3915
+ * @maxLength 100
3916
+ */
3917
+ hashtags?: string[];
3918
+ /**
3919
+ * Category filter.
3920
+ *
3921
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3922
+ * If omitted, all posts with or without associated categories are returned.
3923
+ * @maxSize 50
3924
+ * @format GUID
3925
+ */
3926
+ categoryIds?: string[];
3927
+ /**
3928
+ * Tag filter.
3929
+ *
3930
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3931
+ * If omitted, all posts with or without tags are returned.
3932
+ * @maxSize 50
3933
+ * @format GUID
3934
+ */
3935
+ tagIds?: string[];
3936
+ /**
3937
+ * Sorting options.
3938
+ *
3939
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3940
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3941
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3942
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3943
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3944
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3945
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3946
+ * - `RATING`: reserved for internal use.
3947
+ *
3948
+ * Default: `FEED`
3949
+ */
3950
+ sort?: GetPostsSortWithLiterals;
3951
+ /** Pagination options. */
3952
+ paging?: BlogPaging;
3953
+ /**
3954
+ * __Deprecated.__ Use `fieldsets` instead.
3955
+ * This parameter will be removed on June 30, 2023.
3956
+ *
3957
+ * List of post fields to be included in the response.
3958
+ * @maxSize 20
3959
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3960
+ * This parameter will be removed on June 30, 2023.
3961
+ *
3962
+ * List of post fields to be included in the response.
3963
+ * @replacedBy fieldsets
3964
+ * @targetRemovalDate 2024-06-30
3965
+ */
3966
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3967
+ /**
3968
+ * Language filter.
3969
+ *
3970
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3971
+ * Pass a language to only receive posts that are in that language.
3972
+ * If omitted, posts in all languages are returned.
3973
+ * @format LANGUAGE_TAG
3974
+ */
3975
+ language?: string | null;
3976
+ /**
3977
+ * Post owner's member ID.
3978
+ * @format GUID
3979
+ */
3980
+ memberId?: string | null;
3981
+ /**
3982
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3983
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3984
+ * only the post’s base fields are returned.
3985
+ * @maxSize 20
3986
+ */
3987
+ fieldsets?: PostFieldFieldWithLiterals[];
3988
+ }
3989
+ interface ListDemoPostsResponse {
3990
+ /** List of posts. */
3991
+ posts?: Post[];
3992
+ /** Details on the paged set of results returned. */
3993
+ metaData?: MetaData;
3994
+ }
3995
+ interface ConvertDraftJsToRichContentRequest {
3996
+ /** DraftJs content to convert to Rich content. */
3997
+ content?: Record<string, any> | null;
3998
+ }
3999
+ interface ConvertDraftJsToRichContentResponse {
4000
+ /**
4001
+ * Rich content converted from DraftJs content.
4002
+ * @maxLength 2000000
4003
+ */
4004
+ richContent?: string;
4005
+ }
4006
+ interface ConvertRichContentToDraftJsRequest {
4007
+ /**
4008
+ * Rich content to convert to DraftJs content.
4009
+ * @maxLength 2000000
4010
+ */
4011
+ richContent?: string;
4012
+ }
4013
+ interface ConvertRichContentToDraftJsResponse {
4014
+ /** DraftJs content converted from Rich content. */
4015
+ content?: Record<string, any> | null;
4016
+ }
4017
4017
  interface BaseEventMetadata {
4018
4018
  /**
4019
4019
  * App instance ID.
@@ -4161,13 +4161,14 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
4161
4161
  /**
4162
4162
  * Retrieves the number of published posts per month within a specified time range.
4163
4163
  *
4164
- * The time range is set using the `rangeStart` and `months` properties.
4165
- * The time range always starts on the 1st day of the month set in `rangeStart` and
4166
- * includes the number of `months` following `rangeStart`.
4167
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
4168
- * 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.
4169
- * > 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.
4164
+ *
4165
+ * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
4166
+ *
4167
+ * 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.
4168
+ *
4169
+ * >**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.
4170
4170
  * @public
4171
+ * @param options - Options specifying time frame, sort, and filter.
4171
4172
  * @permissionId BLOG.READ-PUBLICATION
4172
4173
  * @applicableIdentity APP
4173
4174
  * @returns Get Blog Post Count Stats response
@@ -4208,6 +4209,7 @@ interface QueryPostCountStatsOptions {
4208
4209
  /**
4209
4210
  * Retrieves the total amount of published posts of the blog.
4210
4211
  * @public
4212
+ * @param options - Language Options.
4211
4213
  * @permissionId BLOG.READ-PUBLICATION
4212
4214
  * @applicableIdentity APP
4213
4215
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -4228,12 +4230,12 @@ interface GetTotalPostsOptions {
4228
4230
  * @param postId - Post ID.
4229
4231
  * @public
4230
4232
  * @requiredField postId
4233
+ * @param options - Options specifying which fields to return.
4231
4234
  * @permissionId BLOG.READ-PUBLICATION
4232
4235
  * @applicableIdentity APP
4233
- * @returns Retrieved post info.
4234
4236
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
4235
4237
  */
4236
- 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>>;
4238
+ 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>>;
4237
4239
  interface GetPostOptions {
4238
4240
  /**
4239
4241
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4253,6 +4255,7 @@ interface GetPostOptions {
4253
4255
  * @param slug - Slug of the post to retrieve.
4254
4256
  * @public
4255
4257
  * @requiredField slug
4258
+ * @param options - Options specifying which fields to return.
4256
4259
  * @permissionId BLOG.READ-PUBLICATION
4257
4260
  * @applicableIdentity APP
4258
4261
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -4280,6 +4283,7 @@ interface GetPostBySlugOptions {
4280
4283
  * - `paging.limit` is `50`.
4281
4284
  * - `paging.offset` is `0`.
4282
4285
  * @public
4286
+ * @param options - Sort, filter, and paging options.
4283
4287
  * @permissionId BLOG.READ-PUBLICATION
4284
4288
  * @applicableIdentity APP
4285
4289
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -4350,18 +4354,26 @@ interface ListPostsOptions {
4350
4354
  fieldsets?: PostFieldFieldWithLiterals[];
4351
4355
  }
4352
4356
  /**
4353
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
4357
+ * Creates a query to retrieve a list of posts.
4354
4358
  *
4355
- * Query Posts runs with these defaults, which you can override:
4356
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
4357
- * - `paging.limit` is `50`.
4358
- * - `paging.offset` is `0`.
4359
4359
  *
4360
- * To learn about working with _Query_ endpoints, see
4361
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
4362
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
4363
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
4360
+ * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
4361
+ *
4362
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
4363
+ *
4364
+ * 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.
4365
+ *
4366
+ * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
4367
+ * + `limit(50)`
4368
+ * + `descending('firstPublishedDate')`
4369
+ *
4370
+ * Note that the default limit is `'50'`, but the max limit is `'100'`.
4371
+ *
4372
+ * To learn how to query posts, refer to the table below.
4373
+ *
4374
+ * 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`.
4364
4375
  * @public
4376
+ * @param options - Options specifying which fields to return.
4365
4377
  * @permissionId BLOG.READ-PUBLICATION
4366
4378
  * @applicableIdentity APP
4367
4379
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
@@ -4401,19 +4413,19 @@ interface PostsQueryBuilder {
4401
4413
  /** @param propertyName - Property whose value is compared with `value`.
4402
4414
  * @param value - Value to compare against.
4403
4415
  */
4404
- ge: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4416
+ ge: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4405
4417
  /** @param propertyName - Property whose value is compared with `value`.
4406
4418
  * @param value - Value to compare against.
4407
4419
  */
4408
- gt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4420
+ gt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4409
4421
  /** @param propertyName - Property whose value is compared with `value`.
4410
4422
  * @param value - Value to compare against.
4411
4423
  */
4412
- le: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4424
+ le: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4413
4425
  /** @param propertyName - Property whose value is compared with `value`.
4414
4426
  * @param value - Value to compare against.
4415
4427
  */
4416
- lt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4428
+ lt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4417
4429
  /** @param propertyName - Property whose value is compared with `string`.
4418
4430
  * @param string - String to compare against. Case-insensitive.
4419
4431
  */
@@ -4480,16 +4492,7 @@ interface PostQuerySpec extends QuerySpec {
4480
4492
  },
4481
4493
  {
4482
4494
  fields: ['slug'];
4483
- operators: [
4484
- '$eq',
4485
- '$gt',
4486
- '$gte',
4487
- '$hasAll',
4488
- '$hasSome',
4489
- '$lt',
4490
- '$lte',
4491
- '$ne'
4492
- ];
4495
+ operators: ['$eq', '$hasAll', '$hasSome', '$ne'];
4493
4496
  sort: 'BOTH';
4494
4497
  },
4495
4498
  {