@wix/auto_sdk_blog_posts 1.0.141 → 1.0.143

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 (46) hide show
  1. package/build/cjs/index.js +38 -38
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +624 -624
  4. package/build/cjs/index.typings.js +38 -38
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +625 -625
  7. package/build/cjs/meta.js +38 -38
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.d.ts +603 -0
  10. package/build/cjs/schemas.js +982 -0
  11. package/build/cjs/schemas.js.map +1 -0
  12. package/build/es/index.mjs +38 -38
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +624 -624
  15. package/build/es/index.typings.mjs +38 -38
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +625 -625
  18. package/build/es/meta.mjs +38 -38
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/schemas.d.mts +603 -0
  21. package/build/es/schemas.mjs +932 -0
  22. package/build/es/schemas.mjs.map +1 -0
  23. package/build/internal/cjs/index.js +38 -38
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +624 -624
  26. package/build/internal/cjs/index.typings.js +38 -38
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +625 -625
  29. package/build/internal/cjs/meta.js +38 -38
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/cjs/schemas.d.ts +603 -0
  32. package/build/internal/cjs/schemas.js +982 -0
  33. package/build/internal/cjs/schemas.js.map +1 -0
  34. package/build/internal/es/index.mjs +38 -38
  35. package/build/internal/es/index.mjs.map +1 -1
  36. package/build/internal/es/index.typings.d.mts +624 -624
  37. package/build/internal/es/index.typings.mjs +38 -38
  38. package/build/internal/es/index.typings.mjs.map +1 -1
  39. package/build/internal/es/meta.d.mts +625 -625
  40. package/build/internal/es/meta.mjs +38 -38
  41. package/build/internal/es/meta.mjs.map +1 -1
  42. package/build/internal/es/schemas.d.mts +603 -0
  43. package/build/internal/es/schemas.mjs +932 -0
  44. package/build/internal/es/schemas.mjs.map +1 -0
  45. package/package.json +11 -4
  46. package/schemas/package.json +3 -0
@@ -2640,318 +2640,602 @@ interface PostUnlikedInitiatorOneOf {
2640
2640
  */
2641
2641
  anonymousVisitorId?: string | null;
2642
2642
  }
2643
- interface ListTemplatesRequest {
2643
+ interface GetTotalLikesPerMemberRequest {
2644
2644
  /**
2645
- * Filter post templates by given template category ids
2646
- * @maxSize 50
2645
+ * Member ID.
2647
2646
  * @format GUID
2648
2647
  */
2649
- categoryIds?: string[];
2650
- /**
2651
- * Filter post templates by provided language
2652
- * @format LANGUAGE_TAG
2653
- */
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;
2648
+ memberId?: string;
2661
2649
  }
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"
2650
+ interface GetTotalLikesPerMemberResponse {
2651
+ /** The total number of likes of the member. */
2652
+ total?: number;
2667
2653
  }
2668
- /** @enumType */
2669
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2670
- interface BlogPaging {
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;
2671
2661
  /**
2672
- * Number of items to skip in the current sort order.
2673
- *
2674
- *
2675
- * Default: `0`
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`.
2676
2664
  */
2677
- offset?: number;
2665
+ entityFqdn?: string;
2678
2666
  /**
2679
- * Number of items to return.
2680
- *
2681
- *
2682
- * Default:`50`
2683
- * @min 1
2684
- * @max 100
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`.
2685
2669
  */
2686
- limit?: number;
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;
2687
2675
  /**
2688
- * Pointer to the next or previous page in the list of results.
2689
- * @maxLength 2000
2676
+ * Whether the event was triggered as a result of a privacy regulation application
2677
+ * (for example, GDPR).
2690
2678
  */
2691
- cursor?: string | null;
2679
+ triggeredByAnonymizeRequest?: boolean | null;
2680
+ /** If present, indicates the action that triggered the event. */
2681
+ originatedFrom?: string | null;
2682
+ /**
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.
2685
+ */
2686
+ entityEventSequence?: string | null;
2692
2687
  }
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[];
2688
+ /** @oneof */
2689
+ interface DomainEventBodyOneOf {
2690
+ createdEvent?: EntityCreatedEvent;
2691
+ updatedEvent?: EntityUpdatedEvent;
2692
+ deletedEvent?: EntityDeletedEvent;
2693
+ actionEvent?: ActionEvent;
2700
2694
  }
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;
2695
+ interface EntityCreatedEvent {
2696
+ entity?: string;
2697
+ }
2698
+ interface RestoreInfo {
2699
+ deletedDate?: Date | null;
2700
+ }
2701
+ interface EntityUpdatedEvent {
2708
2702
  /**
2709
- * Pointer to the next or previous page in the list of results.
2710
- * @maxLength 2000
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.
2711
2706
  */
2712
- cursor?: string | null;
2707
+ currentEntity?: string;
2713
2708
  }
2714
- interface Category {
2709
+ interface EntityDeletedEvent {
2710
+ /** Entity that was deleted. */
2711
+ deletedEntity?: string | null;
2712
+ }
2713
+ interface ActionEvent {
2714
+ body?: string;
2715
+ }
2716
+ interface MessageEnvelope {
2715
2717
  /**
2716
- * Category ID.
2717
- * @immutable
2718
- * @maxLength 38
2718
+ * App instance ID.
2719
+ * @format GUID
2719
2720
  */
2720
- _id?: string;
2721
+ instanceId?: string | null;
2721
2722
  /**
2722
- * Category label. Displayed in the Category Menu.
2723
- * @maxLength 35
2723
+ * Event type.
2724
+ * @maxLength 150
2724
2725
  */
2725
- label?: string;
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 {
2726
2735
  /**
2727
- * Number of posts in the category.
2728
- * @readonly
2736
+ * ID of a site visitor that has not logged in to the site.
2737
+ * @format GUID
2729
2738
  */
2730
- postCount?: number;
2739
+ anonymousVisitorId?: string;
2731
2740
  /**
2732
- * The `url` of the page that lists every post with the specified category.
2733
- * @readonly
2741
+ * ID of a site visitor that has logged in to the site.
2742
+ * @format GUID
2734
2743
  */
2735
- url?: string;
2744
+ memberId?: string;
2736
2745
  /**
2737
- * Category description.
2738
- * @maxLength 500
2746
+ * ID of a Wix user (site owner, contributor, etc.).
2747
+ * @format GUID
2739
2748
  */
2740
- description?: string | null;
2749
+ wixUserId?: string;
2741
2750
  /**
2742
- * Category title.
2743
- * @maxLength 200
2744
- * @deprecated Category title.
2745
- * @targetRemovalDate 2025-07-16
2751
+ * ID of an app.
2752
+ * @format GUID
2746
2753
  */
2747
- title?: string;
2754
+ appId?: string;
2755
+ /** @readonly */
2756
+ identityType?: WebhookIdentityTypeWithLiterals;
2757
+ }
2758
+ /** @oneof */
2759
+ interface IdentificationDataIdOneOf {
2748
2760
  /**
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`
2761
+ * ID of a site visitor that has not logged in to the site.
2762
+ * @format GUID
2753
2763
  */
2754
- displayPosition?: number | null;
2764
+ anonymousVisitorId?: string;
2755
2765
  /**
2756
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2766
+ * ID of a site visitor that has logged in to the site.
2757
2767
  * @format GUID
2758
2768
  */
2759
- translationId?: string | null;
2769
+ memberId?: string;
2760
2770
  /**
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
2771
+ * ID of a Wix user (site owner, contributor, etc.).
2772
+ * @format GUID
2765
2773
  */
2766
- language?: string | null;
2774
+ wixUserId?: string;
2767
2775
  /**
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
2776
+ * ID of an app.
2777
+ * @format GUID
2770
2778
  */
2771
- slug?: string;
2772
- /** SEO data. */
2773
- seoData?: SeoSchema;
2774
- /** Category cover image. */
2775
- coverImage?: string;
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 {
2776
2791
  /**
2777
- * Date and time the Category was last updated.
2778
- * @readonly
2792
+ * ID of the Wix account associated with the event.
2793
+ * @format GUID
2779
2794
  */
2780
- _updatedDate?: Date | null;
2781
- }
2782
- interface CategoryTranslation {
2795
+ accountId?: string | null;
2783
2796
  /**
2784
- * Category ID.
2797
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2785
2798
  * @format GUID
2786
2799
  */
2787
- _id?: string;
2800
+ parentAccountId?: string | null;
2788
2801
  /**
2789
- * Label displayed in the categories menu on the site.
2790
- * @maxLength 100
2802
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2803
+ * @format GUID
2791
2804
  */
2792
- label?: string | null;
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;
2793
2817
  /**
2794
- * Language of the category.
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.
2795
2821
  * @format LANGUAGE_TAG
2796
2822
  */
2797
2823
  language?: string | null;
2798
- /** URL of this category page. */
2799
- url?: string;
2800
- }
2801
- interface GetTemplateRequest {
2802
2824
  /**
2803
- * Post template id
2804
- * @format GUID
2825
+ * Timezone of the client.
2826
+ * @minLength 3
2827
+ * @maxLength 100
2805
2828
  */
2806
- postTemplateId?: string;
2807
- }
2808
- interface GetTemplateResponse {
2809
- /** Post template */
2810
- postTemplate?: Post;
2829
+ timeZone?: string | null;
2811
2830
  }
2812
- interface CreateDraftPostFromTemplateRequest {
2813
- /**
2814
- * Post template id
2815
- * @format GUID
2816
- */
2817
- postTemplateId?: string;
2831
+ declare enum QueryPublicationsCountStatsRequestOrder {
2832
+ UNKNOWN = "UNKNOWN",
2833
+ OLDEST = "OLDEST",
2834
+ NEWEST = "NEWEST"
2818
2835
  }
2819
- interface CreateDraftPostFromTemplateResponse {
2820
- /** Created draft post */
2821
- draftPost?: DraftPost;
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[];
2822
2842
  }
2823
- interface DraftPost {
2824
- /**
2825
- * Draft post ID.
2826
- * @readonly
2827
- * @maxLength 38
2828
- */
2829
- _id?: string;
2830
- /**
2831
- * Draft post title.
2832
- * @maxLength 200
2833
- */
2834
- title?: string;
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;
2835
2854
  /**
2836
- * Draft post excerpt.
2855
+ * Order of returned results.
2837
2856
  *
2838
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2839
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2840
- * @maxLength 500
2841
- */
2842
- excerpt?: string | null;
2843
- /** Whether the draft post is marked as featured. */
2844
- featured?: boolean | null;
2845
- /**
2846
- * Category IDs of the draft post.
2847
- * @maxSize 10
2848
- * @maxLength 38
2857
+ * - `OLDEST`: posts by date in ascending order.
2858
+ * - `NEWEST`: posts by date in descending order.
2859
+ *
2860
+ * Default: `OLDEST`
2849
2861
  */
2850
- categoryIds?: string[];
2862
+ order?: OrderWithLiterals;
2863
+ /** Number of months to include in response. */
2864
+ months?: number;
2851
2865
  /**
2852
- * Draft post owner's member ID.
2853
- * @format GUID
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
2854
2871
  */
2855
- memberId?: string | null;
2872
+ language?: string | null;
2856
2873
  /**
2857
- * Hashtags in the post.
2858
- * @maxSize 100
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
2859
2878
  * @maxLength 100
2860
2879
  */
2861
- hashtags?: string[];
2862
- /** Whether commenting on the draft post is enabled. */
2863
- commentingEnabled?: boolean | null;
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 {
2864
2902
  /**
2865
- * Estimated reading time of the draft post (calculated automatically).
2866
- * @readonly
2903
+ * Language filter
2904
+ * @minLength 2
2905
+ * @format LANGUAGE_TAG
2867
2906
  */
2868
- minutesToRead?: number;
2869
- /** Image placed at the top of the blog page. */
2870
- heroImage?: string;
2907
+ language?: string | null;
2908
+ }
2909
+ interface GetTotalPublicationsResponse {
2910
+ /** Total amount of publications. */
2911
+ total?: number;
2912
+ }
2913
+ interface GetTotalPostsRequest {
2871
2914
  /**
2872
- * Tag IDs the draft post is tagged with.
2873
- * @maxSize 30
2874
- * @maxLength 38
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
2875
2920
  */
2876
- tagIds?: string[];
2921
+ language?: string | null;
2922
+ }
2923
+ interface GetTotalPostsResponse {
2924
+ /** Total amount of published posts. */
2925
+ total?: number;
2926
+ }
2927
+ interface ListTemplatesRequest {
2877
2928
  /**
2878
- * IDs of posts related to this draft post.
2879
- * @maxSize 3
2880
- * @maxLength 38
2929
+ * Filter post templates by given template category ids
2930
+ * @maxSize 50
2931
+ * @format GUID
2881
2932
  */
2882
- relatedPostIds?: string[];
2933
+ categoryIds?: string[];
2883
2934
  /**
2884
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2885
- * @maxSize 100
2886
- * @format GUID
2935
+ * Filter post templates by provided language
2936
+ * @format LANGUAGE_TAG
2887
2937
  */
2888
- pricingPlanIds?: string[];
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 {
2889
2955
  /**
2890
- * ID of the draft post's translations.
2956
+ * Number of items to skip in the current sort order.
2891
2957
  *
2892
- * All translations of a single post share the same `translationId`.
2893
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2894
- * @format GUID
2958
+ *
2959
+ * Default: `0`
2895
2960
  */
2896
- translationId?: string | null;
2961
+ offset?: number;
2897
2962
  /**
2898
- * Language the draft post is written in.
2963
+ * Number of items to return.
2899
2964
  *
2900
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2901
- * @format LANGUAGE_TAG
2965
+ *
2966
+ * Default:`50`
2967
+ * @min 1
2968
+ * @max 100
2902
2969
  */
2903
- language?: string | null;
2970
+ limit?: number;
2904
2971
  /**
2905
- * Draft Post rich content.
2906
- *
2907
- * <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">
2908
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2909
- * </widget>
2972
+ * Pointer to the next or previous page in the list of results.
2973
+ * @maxLength 2000
2910
2974
  */
2911
- richContent?: RichContent;
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;
2912
2992
  /**
2913
- * Status of the draft post.
2914
- * @readonly
2993
+ * Pointer to the next or previous page in the list of results.
2994
+ * @maxLength 2000
2915
2995
  */
2916
- status?: StatusWithLiterals;
2917
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2918
- moderationDetails?: ModerationDetails;
2996
+ cursor?: string | null;
2997
+ }
2998
+ interface Category {
2919
2999
  /**
2920
- * Indicates if there are changes made to the draft post that have not yet been published.
2921
- * @readonly
3000
+ * Category ID.
3001
+ * @immutable
3002
+ * @maxLength 38
2922
3003
  */
2923
- hasUnpublishedChanges?: boolean;
3004
+ _id?: string;
2924
3005
  /**
2925
- * Date the draft post was last edited.
2926
- * @readonly
3006
+ * Category label. Displayed in the Category Menu.
3007
+ * @maxLength 35
2927
3008
  */
2928
- editedDate?: Date | null;
3009
+ label?: string;
2929
3010
  /**
2930
- * Date the draft post is scheduled to be published.
3011
+ * Number of posts in the category.
2931
3012
  * @readonly
2932
3013
  */
2933
- scheduledPublishDate?: Date | null;
2934
- /** Date the post was first published. */
2935
- firstPublishedDate?: Date | null;
2936
- /** SEO data. */
2937
- seoData?: SeoSchema;
3014
+ postCount?: number;
2938
3015
  /**
2939
- * Draft post URL preview. What the URL will look like once the post is published.
3016
+ * The `url` of the page that lists every post with the specified category.
2940
3017
  * @readonly
2941
3018
  */
2942
3019
  url?: string;
2943
3020
  /**
2944
- * Date the draft post was first created.
2945
- * @readonly
3021
+ * Category description.
3022
+ * @maxLength 500
2946
3023
  */
2947
- _createdDate?: Date | null;
3024
+ description?: string | null;
2948
3025
  /**
2949
- * SEO slug.
2950
- * @maxLength 100
3026
+ * Category title.
3027
+ * @maxLength 200
3028
+ * @deprecated Category title.
3029
+ * @targetRemovalDate 2025-07-16
2951
3030
  */
2952
- seoSlug?: string | null;
2953
- /** Post cover media. */
2954
- media?: Media;
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;
3091
+ }
3092
+ interface GetTemplateResponse {
3093
+ /** Post template */
3094
+ postTemplate?: Post;
3095
+ }
3096
+ interface CreateDraftPostFromTemplateRequest {
3097
+ /**
3098
+ * Post template id
3099
+ * @format GUID
3100
+ */
3101
+ postTemplateId?: string;
3102
+ }
3103
+ interface CreateDraftPostFromTemplateResponse {
3104
+ /** Created draft post */
3105
+ draftPost?: DraftPost;
3106
+ }
3107
+ interface DraftPost {
3108
+ /**
3109
+ * Draft post ID.
3110
+ * @readonly
3111
+ * @maxLength 38
3112
+ */
3113
+ _id?: string;
3114
+ /**
3115
+ * Draft post title.
3116
+ * @maxLength 200
3117
+ */
3118
+ title?: string;
3119
+ /**
3120
+ * Draft post excerpt.
3121
+ *
3122
+ * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3123
+ * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3124
+ * @maxLength 500
3125
+ */
3126
+ excerpt?: string | null;
3127
+ /** Whether the draft post is marked as featured. */
3128
+ featured?: boolean | null;
3129
+ /**
3130
+ * Category IDs of the draft post.
3131
+ * @maxSize 10
3132
+ * @maxLength 38
3133
+ */
3134
+ categoryIds?: string[];
3135
+ /**
3136
+ * Draft post owner's member ID.
3137
+ * @format GUID
3138
+ */
3139
+ memberId?: string | null;
3140
+ /**
3141
+ * Hashtags in the post.
3142
+ * @maxSize 100
3143
+ * @maxLength 100
3144
+ */
3145
+ hashtags?: string[];
3146
+ /** Whether commenting on the draft post is enabled. */
3147
+ commentingEnabled?: boolean | null;
3148
+ /**
3149
+ * Estimated reading time of the draft post (calculated automatically).
3150
+ * @readonly
3151
+ */
3152
+ minutesToRead?: number;
3153
+ /** Image placed at the top of the blog page. */
3154
+ heroImage?: string;
3155
+ /**
3156
+ * Tag IDs the draft post is tagged with.
3157
+ * @maxSize 30
3158
+ * @maxLength 38
3159
+ */
3160
+ tagIds?: string[];
3161
+ /**
3162
+ * IDs of posts related to this draft post.
3163
+ * @maxSize 3
3164
+ * @maxLength 38
3165
+ */
3166
+ relatedPostIds?: string[];
3167
+ /**
3168
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3169
+ * @maxSize 100
3170
+ * @format GUID
3171
+ */
3172
+ pricingPlanIds?: string[];
3173
+ /**
3174
+ * ID of the draft post's translations.
3175
+ *
3176
+ * All translations of a single post share the same `translationId`.
3177
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3178
+ * @format GUID
3179
+ */
3180
+ translationId?: string | null;
3181
+ /**
3182
+ * Language the draft post is written in.
3183
+ *
3184
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3185
+ * @format LANGUAGE_TAG
3186
+ */
3187
+ language?: string | null;
3188
+ /**
3189
+ * Draft Post rich content.
3190
+ *
3191
+ * <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">
3192
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3193
+ * </widget>
3194
+ */
3195
+ richContent?: RichContent;
3196
+ /**
3197
+ * Status of the draft post.
3198
+ * @readonly
3199
+ */
3200
+ status?: StatusWithLiterals;
3201
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3202
+ moderationDetails?: ModerationDetails;
3203
+ /**
3204
+ * Indicates if there are changes made to the draft post that have not yet been published.
3205
+ * @readonly
3206
+ */
3207
+ hasUnpublishedChanges?: boolean;
3208
+ /**
3209
+ * Date the draft post was last edited.
3210
+ * @readonly
3211
+ */
3212
+ editedDate?: Date | null;
3213
+ /**
3214
+ * Date the draft post is scheduled to be published.
3215
+ * @readonly
3216
+ */
3217
+ scheduledPublishDate?: Date | null;
3218
+ /** Date the post was first published. */
3219
+ firstPublishedDate?: Date | null;
3220
+ /** SEO data. */
3221
+ seoData?: SeoSchema;
3222
+ /**
3223
+ * Draft post URL preview. What the URL will look like once the post is published.
3224
+ * @readonly
3225
+ */
3226
+ url?: string;
3227
+ /**
3228
+ * Date the draft post was first created.
3229
+ * @readonly
3230
+ */
3231
+ _createdDate?: Date | null;
3232
+ /**
3233
+ * SEO slug.
3234
+ * @maxLength 100
3235
+ */
3236
+ seoSlug?: string | null;
3237
+ /** Post cover media. */
3238
+ media?: Media;
2955
3239
  /** Number of paragraphs to display in a paid content preview for non-paying users. */
2956
3240
  previewTextParagraph?: number | null;
2957
3241
  }
@@ -3068,289 +3352,157 @@ interface DraftPostTranslation {
3068
3352
  /** Post URL. */
3069
3353
  url?: string;
3070
3354
  }
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;
3078
- /**
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`.
3081
- */
3082
- entityFqdn?: string;
3083
- /**
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`.
3086
- */
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;
3092
- /**
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.
3136
- * @format GUID
3137
- */
3138
- instanceId?: string | null;
3139
- /**
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.
3154
- * @format GUID
3155
- */
3156
- anonymousVisitorId?: string;
3157
- /**
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;
3355
+ interface ListDemoPostsRequest {
3234
3356
  /**
3235
- * Language filter
3357
+ * Whether to return only featured posts.
3236
3358
  *
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
3359
+ * Default: `false`
3239
3360
  */
3240
- language?: string | null;
3361
+ featured?: boolean;
3241
3362
  /**
3242
- * Timezone of the client.
3243
- * @minLength 3
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
3244
3368
  * @maxLength 100
3245
3369
  */
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;
3370
+ hashtags?: string[];
3271
3371
  /**
3272
- * Order of returned results.
3273
- *
3274
- * - `OLDEST`: posts by date in ascending order.
3275
- * - `NEWEST`: posts by date in descending order.
3372
+ * Category filter.
3276
3373
  *
3277
- * Default: `OLDEST`
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
3377
+ * @format GUID
3278
3378
  */
3279
- order?: OrderWithLiterals;
3280
- /** Number of months to include in response. */
3281
- months?: number;
3379
+ categoryIds?: string[];
3282
3380
  /**
3283
- * Language filter.
3381
+ * Tag filter.
3284
3382
  *
3285
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3286
- * Pass a language to only receive the period post count for that specified language.
3287
- * @format LANGUAGE_TAG
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
3386
+ * @format GUID
3288
3387
  */
3289
- language?: string | null;
3388
+ tagIds?: string[];
3290
3389
  /**
3291
- * Time zone to use when calculating the start of the month.
3390
+ * Sorting options.
3292
3391
  *
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
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.
3400
+ *
3401
+ * Default: `FEED`
3296
3402
  */
3297
- timeZone?: string | null;
3298
- }
3299
- declare enum Order {
3300
- UNKNOWN = "UNKNOWN",
3301
- OLDEST = "OLDEST",
3302
- NEWEST = "NEWEST"
3303
- }
3304
- /** @enumType */
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[];
3310
- }
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;
3317
- }
3318
- interface GetTotalPublicationsRequest {
3403
+ sort?: GetPostsSortWithLiterals;
3404
+ /** Pagination options. */
3405
+ paging?: BlogPaging;
3319
3406
  /**
3320
- * Language filter
3321
- * @minLength 2
3322
- * @format LANGUAGE_TAG
3407
+ * __Deprecated.__ Use `fieldsets` instead.
3408
+ * This parameter will be removed on June 30, 2023.
3409
+ *
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.
3414
+ *
3415
+ * List of post fields to be included in the response.
3416
+ * @replacedBy fieldsets
3417
+ * @targetRemovalDate 2024-06-30
3323
3418
  */
3324
- language?: string | null;
3325
- }
3326
- interface GetTotalPublicationsResponse {
3327
- /** Total amount of publications. */
3328
- total?: number;
3329
- }
3330
- interface GetTotalPostsRequest {
3419
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3331
3420
  /**
3332
3421
  * Language filter.
3333
3422
  *
3334
3423
  * 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.
3424
+ * Pass a language to only receive posts that are in that language.
3425
+ * If omitted, posts in all languages are returned.
3336
3426
  * @format LANGUAGE_TAG
3337
3427
  */
3338
3428
  language?: string | null;
3429
+ /**
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[];
3339
3441
  }
3340
- interface GetTotalPostsResponse {
3341
- /** Total amount of published posts. */
3342
- total?: number;
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"
3343
3457
  }
3344
- interface GetTotalLikesPerMemberRequest {
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 {
3461
+ 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"
3476
+ }
3477
+ /** @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;
3484
+ }
3485
+ interface ConvertDraftJsToRichContentRequest {
3486
+ /** DraftJs content to convert to Rich content. */
3487
+ content?: Record<string, any> | null;
3488
+ }
3489
+ interface ConvertDraftJsToRichContentResponse {
3345
3490
  /**
3346
- * Member ID.
3347
- * @format GUID
3491
+ * Rich content converted from DraftJs content.
3492
+ * @maxLength 2000000
3348
3493
  */
3349
- memberId?: string;
3494
+ richContent?: string;
3350
3495
  }
3351
- interface GetTotalLikesPerMemberResponse {
3352
- /** The total number of likes of the member. */
3353
- total?: number;
3496
+ interface ConvertRichContentToDraftJsRequest {
3497
+ /**
3498
+ * Rich content to convert to DraftJs content.
3499
+ * @maxLength 2000000
3500
+ */
3501
+ richContent?: string;
3502
+ }
3503
+ interface ConvertRichContentToDraftJsResponse {
3504
+ /** DraftJs content converted from Rich content. */
3505
+ content?: Record<string, any> | null;
3354
3506
  }
3355
3507
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3356
3508
  /**
@@ -3421,25 +3573,6 @@ interface GetPostRequest {
3421
3573
  */
3422
3574
  fieldsets?: PostFieldFieldWithLiterals[];
3423
3575
  }
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';
3443
3576
  interface GetPostResponse {
3444
3577
  /** Retrieved post info. */
3445
3578
  post?: Post;
@@ -3532,24 +3665,6 @@ interface ListPostsRequest {
3532
3665
  */
3533
3666
  fieldsets?: PostFieldFieldWithLiterals[];
3534
3667
  }
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';
3553
3668
  interface ListPostsResponse {
3554
3669
  /** List of retrieved posts. */
3555
3670
  posts?: Post[];
@@ -3899,121 +4014,6 @@ interface PostCount {
3899
4014
  /** Number of posts. */
3900
4015
  postCount?: number;
3901
4016
  }
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.