@wix/auto_sdk_blog_posts 1.0.148 → 1.0.150

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 (37) 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 +2 -2
  10. package/build/es/index.mjs +38 -38
  11. package/build/es/index.mjs.map +1 -1
  12. package/build/es/index.typings.d.mts +624 -624
  13. package/build/es/index.typings.mjs +38 -38
  14. package/build/es/index.typings.mjs.map +1 -1
  15. package/build/es/meta.d.mts +625 -625
  16. package/build/es/meta.mjs +38 -38
  17. package/build/es/meta.mjs.map +1 -1
  18. package/build/es/schemas.d.mts +2 -2
  19. package/build/internal/cjs/index.js +38 -38
  20. package/build/internal/cjs/index.js.map +1 -1
  21. package/build/internal/cjs/index.typings.d.ts +624 -624
  22. package/build/internal/cjs/index.typings.js +38 -38
  23. package/build/internal/cjs/index.typings.js.map +1 -1
  24. package/build/internal/cjs/meta.d.ts +625 -625
  25. package/build/internal/cjs/meta.js +38 -38
  26. package/build/internal/cjs/meta.js.map +1 -1
  27. package/build/internal/cjs/schemas.d.ts +2 -2
  28. package/build/internal/es/index.mjs +38 -38
  29. package/build/internal/es/index.mjs.map +1 -1
  30. package/build/internal/es/index.typings.d.mts +624 -624
  31. package/build/internal/es/index.typings.mjs +38 -38
  32. package/build/internal/es/index.typings.mjs.map +1 -1
  33. package/build/internal/es/meta.d.mts +625 -625
  34. package/build/internal/es/meta.mjs +38 -38
  35. package/build/internal/es/meta.mjs.map +1 -1
  36. package/build/internal/es/schemas.d.mts +2 -2
  37. package/package.json +2 -2
@@ -2729,318 +2729,602 @@ interface PostUnlikedInitiatorOneOf {
2729
2729
  */
2730
2730
  anonymousVisitorId?: string | null;
2731
2731
  }
2732
- interface ListTemplatesRequest {
2732
+ interface GetTotalLikesPerMemberRequest {
2733
2733
  /**
2734
- * Filter post templates by given template category ids
2735
- * @maxSize 50
2734
+ * Member ID.
2736
2735
  * @format GUID
2737
2736
  */
2738
- categoryIds?: string[];
2739
- /**
2740
- * Filter post templates by provided language
2741
- * @format LANGUAGE_TAG
2742
- */
2743
- language?: string | null;
2744
- /** Returns post template categories when set to TRUE */
2745
- listTemplateCategories?: boolean;
2746
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2747
- sort?: GetPostTemplatesSortWithLiterals;
2748
- /** Pagination options. */
2749
- paging?: BlogPaging;
2737
+ memberId?: string;
2750
2738
  }
2751
- declare enum GetPostTemplatesSort {
2752
- /** Sort by ascending publishing date. */
2753
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2754
- /** Sort by descending publishing date. */
2755
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2739
+ interface GetTotalLikesPerMemberResponse {
2740
+ /** The total number of likes of the member. */
2741
+ total?: number;
2756
2742
  }
2757
- /** @enumType */
2758
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2759
- interface BlogPaging {
2743
+ interface DomainEvent extends DomainEventBodyOneOf {
2744
+ createdEvent?: EntityCreatedEvent;
2745
+ updatedEvent?: EntityUpdatedEvent;
2746
+ deletedEvent?: EntityDeletedEvent;
2747
+ actionEvent?: ActionEvent;
2748
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2749
+ _id?: string;
2760
2750
  /**
2761
- * Number of items to skip in the current sort order.
2762
- *
2763
- *
2764
- * Default: `0`
2751
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2752
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2765
2753
  */
2766
- offset?: number;
2754
+ entityFqdn?: string;
2767
2755
  /**
2768
- * Number of items to return.
2769
- *
2770
- *
2771
- * Default:`50`
2772
- * @min 1
2773
- * @max 100
2756
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2757
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2774
2758
  */
2775
- limit?: number;
2759
+ slug?: string;
2760
+ /** ID of the entity associated with the event. */
2761
+ entityId?: string;
2762
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2763
+ eventTime?: Date | null;
2776
2764
  /**
2777
- * Pointer to the next or previous page in the list of results.
2778
- * @maxLength 2000
2765
+ * Whether the event was triggered as a result of a privacy regulation application
2766
+ * (for example, GDPR).
2779
2767
  */
2780
- cursor?: string | null;
2768
+ triggeredByAnonymizeRequest?: boolean | null;
2769
+ /** If present, indicates the action that triggered the event. */
2770
+ originatedFrom?: string | null;
2771
+ /**
2772
+ * 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.
2773
+ * 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.
2774
+ */
2775
+ entityEventSequence?: string | null;
2781
2776
  }
2782
- interface ListTemplatesResponse {
2783
- /** Available post templates */
2784
- postTemplates?: Post[];
2785
- /** Details on the paged set of posts templates returned. */
2786
- postTemplatesMetaData?: MetaData;
2787
- /** Post template categories. This value is returned empty unless asked explicitly */
2788
- templateCategories?: Category[];
2777
+ /** @oneof */
2778
+ interface DomainEventBodyOneOf {
2779
+ createdEvent?: EntityCreatedEvent;
2780
+ updatedEvent?: EntityUpdatedEvent;
2781
+ deletedEvent?: EntityDeletedEvent;
2782
+ actionEvent?: ActionEvent;
2789
2783
  }
2790
- interface MetaData {
2791
- /** Number of items returned in this response. */
2792
- count?: number;
2793
- /** Requested offset. */
2794
- offset?: number;
2795
- /** Total number of items that match the query. */
2796
- total?: number;
2784
+ interface EntityCreatedEvent {
2785
+ entity?: string;
2786
+ }
2787
+ interface RestoreInfo {
2788
+ deletedDate?: Date | null;
2789
+ }
2790
+ interface EntityUpdatedEvent {
2797
2791
  /**
2798
- * Pointer to the next or previous page in the list of results.
2799
- * @maxLength 2000
2792
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2793
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2794
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2800
2795
  */
2801
- cursor?: string | null;
2796
+ currentEntity?: string;
2802
2797
  }
2803
- interface Category {
2798
+ interface EntityDeletedEvent {
2799
+ /** Entity that was deleted. */
2800
+ deletedEntity?: string | null;
2801
+ }
2802
+ interface ActionEvent {
2803
+ body?: string;
2804
+ }
2805
+ interface MessageEnvelope {
2804
2806
  /**
2805
- * Category ID.
2806
- * @immutable
2807
- * @maxLength 38
2807
+ * App instance ID.
2808
+ * @format GUID
2808
2809
  */
2809
- _id?: string;
2810
+ instanceId?: string | null;
2810
2811
  /**
2811
- * Category label. Displayed in the Category Menu.
2812
- * @maxLength 35
2812
+ * Event type.
2813
+ * @maxLength 150
2813
2814
  */
2814
- label?: string;
2815
+ eventType?: string;
2816
+ /** The identification type and identity data. */
2817
+ identity?: IdentificationData;
2818
+ /** Stringify payload. */
2819
+ data?: string;
2820
+ /** Details related to the account */
2821
+ accountInfo?: AccountInfo;
2822
+ }
2823
+ interface IdentificationData extends IdentificationDataIdOneOf {
2815
2824
  /**
2816
- * Number of posts in the category.
2817
- * @readonly
2825
+ * ID of a site visitor that has not logged in to the site.
2826
+ * @format GUID
2818
2827
  */
2819
- postCount?: number;
2828
+ anonymousVisitorId?: string;
2820
2829
  /**
2821
- * The `url` of the page that lists every post with the specified category.
2822
- * @readonly
2830
+ * ID of a site visitor that has logged in to the site.
2831
+ * @format GUID
2823
2832
  */
2824
- url?: string;
2833
+ memberId?: string;
2825
2834
  /**
2826
- * Category description.
2827
- * @maxLength 500
2835
+ * ID of a Wix user (site owner, contributor, etc.).
2836
+ * @format GUID
2828
2837
  */
2829
- description?: string | null;
2838
+ wixUserId?: string;
2830
2839
  /**
2831
- * Category title.
2832
- * @maxLength 200
2833
- * @deprecated Category title.
2834
- * @targetRemovalDate 2025-07-16
2840
+ * ID of an app.
2841
+ * @format GUID
2835
2842
  */
2836
- title?: string;
2843
+ appId?: string;
2844
+ /** @readonly */
2845
+ identityType?: WebhookIdentityTypeWithLiterals;
2846
+ }
2847
+ /** @oneof */
2848
+ interface IdentificationDataIdOneOf {
2837
2849
  /**
2838
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2839
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2840
- *
2841
- * Default: `-1`
2850
+ * ID of a site visitor that has not logged in to the site.
2851
+ * @format GUID
2842
2852
  */
2843
- displayPosition?: number | null;
2853
+ anonymousVisitorId?: string;
2844
2854
  /**
2845
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2855
+ * ID of a site visitor that has logged in to the site.
2846
2856
  * @format GUID
2847
2857
  */
2848
- translationId?: string | null;
2858
+ memberId?: string;
2849
2859
  /**
2850
- * Category language.
2851
- *
2852
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2853
- * @immutable
2860
+ * ID of a Wix user (site owner, contributor, etc.).
2861
+ * @format GUID
2854
2862
  */
2855
- language?: string | null;
2863
+ wixUserId?: string;
2856
2864
  /**
2857
- * 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`.
2858
- * @maxLength 100
2865
+ * ID of an app.
2866
+ * @format GUID
2859
2867
  */
2860
- slug?: string;
2861
- /** SEO data. */
2862
- seoData?: SeoSchema;
2863
- /** Category cover image. */
2864
- coverImage?: string;
2868
+ appId?: string;
2869
+ }
2870
+ declare enum WebhookIdentityType {
2871
+ UNKNOWN = "UNKNOWN",
2872
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2873
+ MEMBER = "MEMBER",
2874
+ WIX_USER = "WIX_USER",
2875
+ APP = "APP"
2876
+ }
2877
+ /** @enumType */
2878
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2879
+ interface AccountInfo {
2865
2880
  /**
2866
- * Date and time the Category was last updated.
2867
- * @readonly
2881
+ * ID of the Wix account associated with the event.
2882
+ * @format GUID
2868
2883
  */
2869
- _updatedDate?: Date | null;
2870
- }
2871
- interface CategoryTranslation {
2884
+ accountId?: string | null;
2872
2885
  /**
2873
- * Category ID.
2886
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2874
2887
  * @format GUID
2875
2888
  */
2876
- _id?: string;
2889
+ parentAccountId?: string | null;
2877
2890
  /**
2878
- * Label displayed in the categories menu on the site.
2879
- * @maxLength 100
2891
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2892
+ * @format GUID
2880
2893
  */
2881
- label?: string | null;
2894
+ siteId?: string | null;
2895
+ }
2896
+ /** Get Blog Publications Count Stats request */
2897
+ interface QueryPublicationsCountStatsRequest {
2898
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2899
+ rangeStart?: Date | null;
2900
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2901
+ rangeEnd?: Date | null;
2902
+ /** Order of the returned results. */
2903
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2904
+ /** Number of months to include in the response. */
2905
+ months?: number;
2882
2906
  /**
2883
- * Language of the category.
2907
+ * Language filter
2908
+ *
2909
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2884
2910
  * @format LANGUAGE_TAG
2885
2911
  */
2886
2912
  language?: string | null;
2887
- /** URL of this category page. */
2888
- url?: string;
2889
- }
2890
- interface GetTemplateRequest {
2891
2913
  /**
2892
- * Post template id
2893
- * @format GUID
2914
+ * Timezone of the client.
2915
+ * @minLength 3
2916
+ * @maxLength 100
2894
2917
  */
2895
- postTemplateId?: string;
2896
- }
2897
- interface GetTemplateResponse {
2898
- /** Post template */
2899
- postTemplate?: Post;
2918
+ timeZone?: string | null;
2900
2919
  }
2901
- interface CreateDraftPostFromTemplateRequest {
2902
- /**
2903
- * Post template id
2904
- * @format GUID
2905
- */
2906
- postTemplateId?: string;
2920
+ declare enum QueryPublicationsCountStatsRequestOrder {
2921
+ UNKNOWN = "UNKNOWN",
2922
+ OLDEST = "OLDEST",
2923
+ NEWEST = "NEWEST"
2907
2924
  }
2908
- interface CreateDraftPostFromTemplateResponse {
2909
- /** Created draft post */
2910
- draftPost?: DraftPost;
2925
+ /** @enumType */
2926
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2927
+ /** Get Blog Publications Count Stats response */
2928
+ interface QueryPublicationsCountStatsResponse {
2929
+ /** Chronologically ordered list of publications. */
2930
+ stats?: PeriodPublicationsCount[];
2911
2931
  }
2912
- interface DraftPost {
2913
- /**
2914
- * Draft post ID.
2915
- * @readonly
2916
- * @maxLength 38
2917
- */
2918
- _id?: string;
2919
- /**
2920
- * Draft post title.
2921
- * @maxLength 200
2922
- */
2923
- title?: string;
2932
+ /** Publications count for a specific time period */
2933
+ interface PeriodPublicationsCount {
2934
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2935
+ periodStart?: Date | null;
2936
+ /** Number of posts published during this month. */
2937
+ publicationsCount?: number;
2938
+ }
2939
+ /** Get Blog Post Count Stats request */
2940
+ interface QueryPostCountStatsRequest {
2941
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2942
+ rangeStart?: Date | null;
2924
2943
  /**
2925
- * Draft post excerpt.
2944
+ * Order of returned results.
2926
2945
  *
2927
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2928
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2929
- * @maxLength 500
2930
- */
2931
- excerpt?: string | null;
2932
- /** Whether the draft post is marked as featured. */
2933
- featured?: boolean | null;
2934
- /**
2935
- * Category IDs of the draft post.
2936
- * @maxSize 10
2937
- * @maxLength 38
2946
+ * - `OLDEST`: posts by date in ascending order.
2947
+ * - `NEWEST`: posts by date in descending order.
2948
+ *
2949
+ * Default: `OLDEST`
2938
2950
  */
2939
- categoryIds?: string[];
2951
+ order?: OrderWithLiterals;
2952
+ /** Number of months to include in response. */
2953
+ months?: number;
2940
2954
  /**
2941
- * Draft post owner's member ID.
2942
- * @format GUID
2955
+ * Language filter.
2956
+ *
2957
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2958
+ * Pass a language to only receive the period post count for that specified language.
2959
+ * @format LANGUAGE_TAG
2943
2960
  */
2944
- memberId?: string | null;
2961
+ language?: string | null;
2945
2962
  /**
2946
- * Hashtags in the post.
2947
- * @maxSize 100
2963
+ * Time zone to use when calculating the start of the month.
2964
+ *
2965
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2966
+ * @minLength 3
2948
2967
  * @maxLength 100
2949
2968
  */
2950
- hashtags?: string[];
2951
- /** Whether commenting on the draft post is enabled. */
2952
- commentingEnabled?: boolean | null;
2969
+ timeZone?: string | null;
2970
+ }
2971
+ declare enum Order {
2972
+ UNKNOWN = "UNKNOWN",
2973
+ OLDEST = "OLDEST",
2974
+ NEWEST = "NEWEST"
2975
+ }
2976
+ /** @enumType */
2977
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2978
+ /** Get Blog Post Count Stats response */
2979
+ interface QueryPostCountStatsResponse {
2980
+ /** List of published post counts by month. */
2981
+ stats?: PeriodPostCount[];
2982
+ }
2983
+ /** Post count for a specific time period */
2984
+ interface PeriodPostCount {
2985
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2986
+ periodStart?: Date | null;
2987
+ /** Number of posts published during this month. */
2988
+ postCount?: number;
2989
+ }
2990
+ interface GetTotalPublicationsRequest {
2953
2991
  /**
2954
- * Estimated reading time of the draft post (calculated automatically).
2955
- * @readonly
2992
+ * Language filter
2993
+ * @minLength 2
2994
+ * @format LANGUAGE_TAG
2956
2995
  */
2957
- minutesToRead?: number;
2958
- /** Image placed at the top of the blog page. */
2959
- heroImage?: string;
2996
+ language?: string | null;
2997
+ }
2998
+ interface GetTotalPublicationsResponse {
2999
+ /** Total amount of publications. */
3000
+ total?: number;
3001
+ }
3002
+ interface GetTotalPostsRequest {
2960
3003
  /**
2961
- * Tag IDs the draft post is tagged with.
2962
- * @maxSize 30
2963
- * @maxLength 38
3004
+ * Language filter.
3005
+ *
3006
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3007
+ * Pass a language to receive the total amount of posts in that specified language.
3008
+ * @format LANGUAGE_TAG
2964
3009
  */
2965
- tagIds?: string[];
3010
+ language?: string | null;
3011
+ }
3012
+ interface GetTotalPostsResponse {
3013
+ /** Total amount of published posts. */
3014
+ total?: number;
3015
+ }
3016
+ interface ListTemplatesRequest {
2966
3017
  /**
2967
- * IDs of posts related to this draft post.
2968
- * @maxSize 3
2969
- * @maxLength 38
3018
+ * Filter post templates by given template category ids
3019
+ * @maxSize 50
3020
+ * @format GUID
2970
3021
  */
2971
- relatedPostIds?: string[];
3022
+ categoryIds?: string[];
2972
3023
  /**
2973
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2974
- * @maxSize 100
2975
- * @format GUID
3024
+ * Filter post templates by provided language
3025
+ * @format LANGUAGE_TAG
2976
3026
  */
2977
- pricingPlanIds?: string[];
3027
+ language?: string | null;
3028
+ /** Returns post template categories when set to TRUE */
3029
+ listTemplateCategories?: boolean;
3030
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
3031
+ sort?: GetPostTemplatesSortWithLiterals;
3032
+ /** Pagination options. */
3033
+ paging?: BlogPaging;
3034
+ }
3035
+ declare enum GetPostTemplatesSort {
3036
+ /** Sort by ascending publishing date. */
3037
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3038
+ /** Sort by descending publishing date. */
3039
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
3040
+ }
3041
+ /** @enumType */
3042
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
3043
+ interface BlogPaging {
2978
3044
  /**
2979
- * ID of the draft post's translations.
3045
+ * Number of items to skip in the current sort order.
2980
3046
  *
2981
- * All translations of a single post share the same `translationId`.
2982
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2983
- * @format GUID
3047
+ *
3048
+ * Default: `0`
2984
3049
  */
2985
- translationId?: string | null;
3050
+ offset?: number;
2986
3051
  /**
2987
- * Language the draft post is written in.
3052
+ * Number of items to return.
2988
3053
  *
2989
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2990
- * @format LANGUAGE_TAG
3054
+ *
3055
+ * Default:`50`
3056
+ * @min 1
3057
+ * @max 100
2991
3058
  */
2992
- language?: string | null;
3059
+ limit?: number;
2993
3060
  /**
2994
- * Draft Post rich content.
2995
- *
2996
- * <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">
2997
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2998
- * </widget>
3061
+ * Pointer to the next or previous page in the list of results.
3062
+ * @maxLength 2000
2999
3063
  */
3000
- richContent?: RichContent;
3064
+ cursor?: string | null;
3065
+ }
3066
+ interface ListTemplatesResponse {
3067
+ /** Available post templates */
3068
+ postTemplates?: Post[];
3069
+ /** Details on the paged set of posts templates returned. */
3070
+ postTemplatesMetaData?: MetaData;
3071
+ /** Post template categories. This value is returned empty unless asked explicitly */
3072
+ templateCategories?: Category[];
3073
+ }
3074
+ interface MetaData {
3075
+ /** Number of items returned in this response. */
3076
+ count?: number;
3077
+ /** Requested offset. */
3078
+ offset?: number;
3079
+ /** Total number of items that match the query. */
3080
+ total?: number;
3001
3081
  /**
3002
- * Status of the draft post.
3003
- * @readonly
3082
+ * Pointer to the next or previous page in the list of results.
3083
+ * @maxLength 2000
3004
3084
  */
3005
- status?: StatusWithLiterals;
3006
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3007
- moderationDetails?: ModerationDetails;
3085
+ cursor?: string | null;
3086
+ }
3087
+ interface Category {
3008
3088
  /**
3009
- * Indicates if there are changes made to the draft post that have not yet been published.
3010
- * @readonly
3089
+ * Category ID.
3090
+ * @immutable
3091
+ * @maxLength 38
3011
3092
  */
3012
- hasUnpublishedChanges?: boolean;
3093
+ _id?: string;
3013
3094
  /**
3014
- * Date the draft post was last edited.
3015
- * @readonly
3095
+ * Category label. Displayed in the Category Menu.
3096
+ * @maxLength 35
3016
3097
  */
3017
- editedDate?: Date | null;
3098
+ label?: string;
3018
3099
  /**
3019
- * Date the draft post is scheduled to be published.
3100
+ * Number of posts in the category.
3020
3101
  * @readonly
3021
3102
  */
3022
- scheduledPublishDate?: Date | null;
3023
- /** Date the post was first published. */
3024
- firstPublishedDate?: Date | null;
3025
- /** SEO data. */
3026
- seoData?: SeoSchema;
3103
+ postCount?: number;
3027
3104
  /**
3028
- * Draft post URL preview. What the URL will look like once the post is published.
3105
+ * The `url` of the page that lists every post with the specified category.
3029
3106
  * @readonly
3030
3107
  */
3031
3108
  url?: string;
3032
3109
  /**
3033
- * Date the draft post was first created.
3034
- * @readonly
3110
+ * Category description.
3111
+ * @maxLength 500
3035
3112
  */
3036
- _createdDate?: Date | null;
3113
+ description?: string | null;
3037
3114
  /**
3038
- * SEO slug.
3039
- * @maxLength 100
3115
+ * Category title.
3116
+ * @maxLength 200
3117
+ * @deprecated Category title.
3118
+ * @targetRemovalDate 2025-07-16
3040
3119
  */
3041
- seoSlug?: string | null;
3042
- /** Post cover media. */
3043
- media?: Media;
3120
+ title?: string;
3121
+ /**
3122
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
3123
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
3124
+ *
3125
+ * Default: `-1`
3126
+ */
3127
+ displayPosition?: number | null;
3128
+ /**
3129
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
3130
+ * @format GUID
3131
+ */
3132
+ translationId?: string | null;
3133
+ /**
3134
+ * Category language.
3135
+ *
3136
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3137
+ * @immutable
3138
+ */
3139
+ language?: string | null;
3140
+ /**
3141
+ * 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`.
3142
+ * @maxLength 100
3143
+ */
3144
+ slug?: string;
3145
+ /** SEO data. */
3146
+ seoData?: SeoSchema;
3147
+ /** Category cover image. */
3148
+ coverImage?: string;
3149
+ /**
3150
+ * Date and time the Category was last updated.
3151
+ * @readonly
3152
+ */
3153
+ _updatedDate?: Date | null;
3154
+ }
3155
+ interface CategoryTranslation {
3156
+ /**
3157
+ * Category ID.
3158
+ * @format GUID
3159
+ */
3160
+ _id?: string;
3161
+ /**
3162
+ * Label displayed in the categories menu on the site.
3163
+ * @maxLength 100
3164
+ */
3165
+ label?: string | null;
3166
+ /**
3167
+ * Language of the category.
3168
+ * @format LANGUAGE_TAG
3169
+ */
3170
+ language?: string | null;
3171
+ /** URL of this category page. */
3172
+ url?: string;
3173
+ }
3174
+ interface GetTemplateRequest {
3175
+ /**
3176
+ * Post template id
3177
+ * @format GUID
3178
+ */
3179
+ postTemplateId?: string;
3180
+ }
3181
+ interface GetTemplateResponse {
3182
+ /** Post template */
3183
+ postTemplate?: Post;
3184
+ }
3185
+ interface CreateDraftPostFromTemplateRequest {
3186
+ /**
3187
+ * Post template id
3188
+ * @format GUID
3189
+ */
3190
+ postTemplateId?: string;
3191
+ }
3192
+ interface CreateDraftPostFromTemplateResponse {
3193
+ /** Created draft post */
3194
+ draftPost?: DraftPost;
3195
+ }
3196
+ interface DraftPost {
3197
+ /**
3198
+ * Draft post ID.
3199
+ * @readonly
3200
+ * @maxLength 38
3201
+ */
3202
+ _id?: string;
3203
+ /**
3204
+ * Draft post title.
3205
+ * @maxLength 200
3206
+ */
3207
+ title?: string;
3208
+ /**
3209
+ * Draft post excerpt.
3210
+ *
3211
+ * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3212
+ * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3213
+ * @maxLength 500
3214
+ */
3215
+ excerpt?: string | null;
3216
+ /** Whether the draft post is marked as featured. */
3217
+ featured?: boolean | null;
3218
+ /**
3219
+ * Category IDs of the draft post.
3220
+ * @maxSize 10
3221
+ * @maxLength 38
3222
+ */
3223
+ categoryIds?: string[];
3224
+ /**
3225
+ * Draft post owner's member ID.
3226
+ * @format GUID
3227
+ */
3228
+ memberId?: string | null;
3229
+ /**
3230
+ * Hashtags in the post.
3231
+ * @maxSize 100
3232
+ * @maxLength 100
3233
+ */
3234
+ hashtags?: string[];
3235
+ /** Whether commenting on the draft post is enabled. */
3236
+ commentingEnabled?: boolean | null;
3237
+ /**
3238
+ * Estimated reading time of the draft post (calculated automatically).
3239
+ * @readonly
3240
+ */
3241
+ minutesToRead?: number;
3242
+ /** Image placed at the top of the blog page. */
3243
+ heroImage?: string;
3244
+ /**
3245
+ * Tag IDs the draft post is tagged with.
3246
+ * @maxSize 30
3247
+ * @maxLength 38
3248
+ */
3249
+ tagIds?: string[];
3250
+ /**
3251
+ * IDs of posts related to this draft post.
3252
+ * @maxSize 3
3253
+ * @maxLength 38
3254
+ */
3255
+ relatedPostIds?: string[];
3256
+ /**
3257
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3258
+ * @maxSize 100
3259
+ * @format GUID
3260
+ */
3261
+ pricingPlanIds?: string[];
3262
+ /**
3263
+ * ID of the draft post's translations.
3264
+ *
3265
+ * All translations of a single post share the same `translationId`.
3266
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3267
+ * @format GUID
3268
+ */
3269
+ translationId?: string | null;
3270
+ /**
3271
+ * Language the draft post is written in.
3272
+ *
3273
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3274
+ * @format LANGUAGE_TAG
3275
+ */
3276
+ language?: string | null;
3277
+ /**
3278
+ * Draft Post rich content.
3279
+ *
3280
+ * <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">
3281
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3282
+ * </widget>
3283
+ */
3284
+ richContent?: RichContent;
3285
+ /**
3286
+ * Status of the draft post.
3287
+ * @readonly
3288
+ */
3289
+ status?: StatusWithLiterals;
3290
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3291
+ moderationDetails?: ModerationDetails;
3292
+ /**
3293
+ * Indicates if there are changes made to the draft post that have not yet been published.
3294
+ * @readonly
3295
+ */
3296
+ hasUnpublishedChanges?: boolean;
3297
+ /**
3298
+ * Date the draft post was last edited.
3299
+ * @readonly
3300
+ */
3301
+ editedDate?: Date | null;
3302
+ /**
3303
+ * Date the draft post is scheduled to be published.
3304
+ * @readonly
3305
+ */
3306
+ scheduledPublishDate?: Date | null;
3307
+ /** Date the post was first published. */
3308
+ firstPublishedDate?: Date | null;
3309
+ /** SEO data. */
3310
+ seoData?: SeoSchema;
3311
+ /**
3312
+ * Draft post URL preview. What the URL will look like once the post is published.
3313
+ * @readonly
3314
+ */
3315
+ url?: string;
3316
+ /**
3317
+ * Date the draft post was first created.
3318
+ * @readonly
3319
+ */
3320
+ _createdDate?: Date | null;
3321
+ /**
3322
+ * SEO slug.
3323
+ * @maxLength 100
3324
+ */
3325
+ seoSlug?: string | null;
3326
+ /** Post cover media. */
3327
+ media?: Media;
3044
3328
  /** Number of paragraphs to display in a paid content preview for non-paying users. */
3045
3329
  previewTextParagraph?: number | null;
3046
3330
  }
@@ -3157,289 +3441,157 @@ interface DraftPostTranslation {
3157
3441
  /** Post URL. */
3158
3442
  url?: string;
3159
3443
  }
3160
- interface DomainEvent extends DomainEventBodyOneOf {
3161
- createdEvent?: EntityCreatedEvent;
3162
- updatedEvent?: EntityUpdatedEvent;
3163
- deletedEvent?: EntityDeletedEvent;
3164
- actionEvent?: ActionEvent;
3165
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3166
- _id?: string;
3167
- /**
3168
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3169
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3170
- */
3171
- entityFqdn?: string;
3172
- /**
3173
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
3174
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3175
- */
3176
- slug?: string;
3177
- /** ID of the entity associated with the event. */
3178
- entityId?: string;
3179
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3180
- eventTime?: Date | null;
3181
- /**
3182
- * Whether the event was triggered as a result of a privacy regulation application
3183
- * (for example, GDPR).
3184
- */
3185
- triggeredByAnonymizeRequest?: boolean | null;
3186
- /** If present, indicates the action that triggered the event. */
3187
- originatedFrom?: string | null;
3188
- /**
3189
- * 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.
3190
- * 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.
3191
- */
3192
- entityEventSequence?: string | null;
3193
- }
3194
- /** @oneof */
3195
- interface DomainEventBodyOneOf {
3196
- createdEvent?: EntityCreatedEvent;
3197
- updatedEvent?: EntityUpdatedEvent;
3198
- deletedEvent?: EntityDeletedEvent;
3199
- actionEvent?: ActionEvent;
3200
- }
3201
- interface EntityCreatedEvent {
3202
- entity?: string;
3203
- }
3204
- interface RestoreInfo {
3205
- deletedDate?: Date | null;
3206
- }
3207
- interface EntityUpdatedEvent {
3208
- /**
3209
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3210
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3211
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3212
- */
3213
- currentEntity?: string;
3214
- }
3215
- interface EntityDeletedEvent {
3216
- /** Entity that was deleted. */
3217
- deletedEntity?: string | null;
3218
- }
3219
- interface ActionEvent {
3220
- body?: string;
3221
- }
3222
- interface MessageEnvelope {
3223
- /**
3224
- * App instance ID.
3225
- * @format GUID
3226
- */
3227
- instanceId?: string | null;
3228
- /**
3229
- * Event type.
3230
- * @maxLength 150
3231
- */
3232
- eventType?: string;
3233
- /** The identification type and identity data. */
3234
- identity?: IdentificationData;
3235
- /** Stringify payload. */
3236
- data?: string;
3237
- /** Details related to the account */
3238
- accountInfo?: AccountInfo;
3239
- }
3240
- interface IdentificationData extends IdentificationDataIdOneOf {
3241
- /**
3242
- * ID of a site visitor that has not logged in to the site.
3243
- * @format GUID
3244
- */
3245
- anonymousVisitorId?: string;
3246
- /**
3247
- * ID of a site visitor that has logged in to the site.
3248
- * @format GUID
3249
- */
3250
- memberId?: string;
3251
- /**
3252
- * ID of a Wix user (site owner, contributor, etc.).
3253
- * @format GUID
3254
- */
3255
- wixUserId?: string;
3256
- /**
3257
- * ID of an app.
3258
- * @format GUID
3259
- */
3260
- appId?: string;
3261
- /** @readonly */
3262
- identityType?: WebhookIdentityTypeWithLiterals;
3263
- }
3264
- /** @oneof */
3265
- interface IdentificationDataIdOneOf {
3266
- /**
3267
- * ID of a site visitor that has not logged in to the site.
3268
- * @format GUID
3269
- */
3270
- anonymousVisitorId?: string;
3271
- /**
3272
- * ID of a site visitor that has logged in to the site.
3273
- * @format GUID
3274
- */
3275
- memberId?: string;
3276
- /**
3277
- * ID of a Wix user (site owner, contributor, etc.).
3278
- * @format GUID
3279
- */
3280
- wixUserId?: string;
3281
- /**
3282
- * ID of an app.
3283
- * @format GUID
3284
- */
3285
- appId?: string;
3286
- }
3287
- declare enum WebhookIdentityType {
3288
- UNKNOWN = "UNKNOWN",
3289
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3290
- MEMBER = "MEMBER",
3291
- WIX_USER = "WIX_USER",
3292
- APP = "APP"
3293
- }
3294
- /** @enumType */
3295
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3296
- interface AccountInfo {
3297
- /**
3298
- * ID of the Wix account associated with the event.
3299
- * @format GUID
3300
- */
3301
- accountId?: string | null;
3302
- /**
3303
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
3304
- * @format GUID
3305
- */
3306
- parentAccountId?: string | null;
3307
- /**
3308
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3309
- * @format GUID
3310
- */
3311
- siteId?: string | null;
3312
- }
3313
- /** Get Blog Publications Count Stats request */
3314
- interface QueryPublicationsCountStatsRequest {
3315
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3316
- rangeStart?: Date | null;
3317
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3318
- rangeEnd?: Date | null;
3319
- /** Order of the returned results. */
3320
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3321
- /** Number of months to include in the response. */
3322
- months?: number;
3444
+ interface ListDemoPostsRequest {
3323
3445
  /**
3324
- * Language filter
3446
+ * Whether to return only featured posts.
3325
3447
  *
3326
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3327
- * @format LANGUAGE_TAG
3448
+ * Default: `false`
3328
3449
  */
3329
- language?: string | null;
3450
+ featured?: boolean;
3330
3451
  /**
3331
- * Timezone of the client.
3332
- * @minLength 3
3452
+ * Hashtag filter.
3453
+ *
3454
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3455
+ * If omitted, all posts with or without hashtags are returned.
3456
+ * @maxSize 100
3333
3457
  * @maxLength 100
3334
3458
  */
3335
- timeZone?: string | null;
3336
- }
3337
- declare enum QueryPublicationsCountStatsRequestOrder {
3338
- UNKNOWN = "UNKNOWN",
3339
- OLDEST = "OLDEST",
3340
- NEWEST = "NEWEST"
3341
- }
3342
- /** @enumType */
3343
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3344
- /** Get Blog Publications Count Stats response */
3345
- interface QueryPublicationsCountStatsResponse {
3346
- /** Chronologically ordered list of publications. */
3347
- stats?: PeriodPublicationsCount[];
3348
- }
3349
- /** Publications count for a specific time period */
3350
- interface PeriodPublicationsCount {
3351
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3352
- periodStart?: Date | null;
3353
- /** Number of posts published during this month. */
3354
- publicationsCount?: number;
3355
- }
3356
- /** Get Blog Post Count Stats request */
3357
- interface QueryPostCountStatsRequest {
3358
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3359
- rangeStart?: Date | null;
3459
+ hashtags?: string[];
3360
3460
  /**
3361
- * Order of returned results.
3362
- *
3363
- * - `OLDEST`: posts by date in ascending order.
3364
- * - `NEWEST`: posts by date in descending order.
3461
+ * Category filter.
3365
3462
  *
3366
- * Default: `OLDEST`
3463
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3464
+ * If omitted, all posts with or without associated categories are returned.
3465
+ * @maxSize 50
3466
+ * @format GUID
3367
3467
  */
3368
- order?: OrderWithLiterals;
3369
- /** Number of months to include in response. */
3370
- months?: number;
3468
+ categoryIds?: string[];
3371
3469
  /**
3372
- * Language filter.
3470
+ * Tag filter.
3373
3471
  *
3374
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3375
- * Pass a language to only receive the period post count for that specified language.
3376
- * @format LANGUAGE_TAG
3472
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3473
+ * If omitted, all posts with or without tags are returned.
3474
+ * @maxSize 50
3475
+ * @format GUID
3377
3476
  */
3378
- language?: string | null;
3477
+ tagIds?: string[];
3379
3478
  /**
3380
- * Time zone to use when calculating the start of the month.
3479
+ * Sorting options.
3381
3480
  *
3382
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3383
- * @minLength 3
3384
- * @maxLength 100
3481
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3482
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3483
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3484
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3485
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3486
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3487
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3488
+ * - `RATING`: reserved for internal use.
3489
+ *
3490
+ * Default: `FEED`
3385
3491
  */
3386
- timeZone?: string | null;
3387
- }
3388
- declare enum Order {
3389
- UNKNOWN = "UNKNOWN",
3390
- OLDEST = "OLDEST",
3391
- NEWEST = "NEWEST"
3392
- }
3393
- /** @enumType */
3394
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3395
- /** Get Blog Post Count Stats response */
3396
- interface QueryPostCountStatsResponse {
3397
- /** List of published post counts by month. */
3398
- stats?: PeriodPostCount[];
3399
- }
3400
- /** Post count for a specific time period */
3401
- interface PeriodPostCount {
3402
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3403
- periodStart?: Date | null;
3404
- /** Number of posts published during this month. */
3405
- postCount?: number;
3406
- }
3407
- interface GetTotalPublicationsRequest {
3492
+ sort?: GetPostsSortWithLiterals;
3493
+ /** Pagination options. */
3494
+ paging?: BlogPaging;
3408
3495
  /**
3409
- * Language filter
3410
- * @minLength 2
3411
- * @format LANGUAGE_TAG
3496
+ * __Deprecated.__ Use `fieldsets` instead.
3497
+ * This parameter will be removed on June 30, 2023.
3498
+ *
3499
+ * List of post fields to be included in the response.
3500
+ * @maxSize 20
3501
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3502
+ * This parameter will be removed on June 30, 2023.
3503
+ *
3504
+ * List of post fields to be included in the response.
3505
+ * @replacedBy fieldsets
3506
+ * @targetRemovalDate 2024-06-30
3412
3507
  */
3413
- language?: string | null;
3414
- }
3415
- interface GetTotalPublicationsResponse {
3416
- /** Total amount of publications. */
3417
- total?: number;
3418
- }
3419
- interface GetTotalPostsRequest {
3508
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3420
3509
  /**
3421
3510
  * Language filter.
3422
3511
  *
3423
3512
  * 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 receive the total amount of posts in that specified language.
3513
+ * Pass a language to only receive posts that are in that language.
3514
+ * If omitted, posts in all languages are returned.
3425
3515
  * @format LANGUAGE_TAG
3426
3516
  */
3427
3517
  language?: string | null;
3518
+ /**
3519
+ * Post owner's member ID.
3520
+ * @format GUID
3521
+ */
3522
+ memberId?: string | null;
3523
+ /**
3524
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3525
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3526
+ * only the post’s base fields are returned.
3527
+ * @maxSize 20
3528
+ */
3529
+ fieldsets?: PostFieldFieldWithLiterals[];
3428
3530
  }
3429
- interface GetTotalPostsResponse {
3430
- /** Total amount of published posts. */
3431
- total?: number;
3531
+ declare enum GetPostsSort {
3532
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3533
+ FEED = "FEED",
3534
+ /** Ordered by `firstPublishedDate` in ascending order. */
3535
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3536
+ /** Ordered by `firstPublishedDate` in descending order. */
3537
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3538
+ /** Ordered by total number of views in descending order. */
3539
+ VIEW_COUNT = "VIEW_COUNT",
3540
+ /** Ordered by total number of likes in descending order. */
3541
+ LIKE_COUNT = "LIKE_COUNT",
3542
+ /** Ordered by `title` in ascending order. */
3543
+ TITLE_ASC = "TITLE_ASC",
3544
+ /** Ordered by `title` in descending order. */
3545
+ TITLE_DESC = "TITLE_DESC"
3432
3546
  }
3433
- interface GetTotalLikesPerMemberRequest {
3547
+ /** @enumType */
3548
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3549
+ declare enum PostFieldField {
3550
+ UNKNOWN = "UNKNOWN",
3551
+ /** Includes post URL when present. */
3552
+ URL = "URL",
3553
+ /** Includes post content text string when present. */
3554
+ CONTENT_TEXT = "CONTENT_TEXT",
3555
+ /** Includes post metrics when present. */
3556
+ METRICS = "METRICS",
3557
+ /** Includes SEO data. */
3558
+ SEO = "SEO",
3559
+ /** Includes post owner's contact ID. */
3560
+ CONTACT_ID = "CONTACT_ID",
3561
+ /** Includes post rich content. */
3562
+ RICH_CONTENT = "RICH_CONTENT",
3563
+ /** Includes post reference ID field. */
3564
+ REFERENCE_ID = "REFERENCE_ID"
3565
+ }
3566
+ /** @enumType */
3567
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3568
+ interface ListDemoPostsResponse {
3569
+ /** List of posts. */
3570
+ posts?: Post[];
3571
+ /** Details on the paged set of results returned. */
3572
+ metaData?: MetaData;
3573
+ }
3574
+ interface ConvertDraftJsToRichContentRequest {
3575
+ /** DraftJs content to convert to Rich content. */
3576
+ content?: Record<string, any> | null;
3577
+ }
3578
+ interface ConvertDraftJsToRichContentResponse {
3434
3579
  /**
3435
- * Member ID.
3436
- * @format GUID
3580
+ * Rich content converted from DraftJs content.
3581
+ * @maxLength 2000000
3437
3582
  */
3438
- memberId?: string;
3583
+ richContent?: string;
3439
3584
  }
3440
- interface GetTotalLikesPerMemberResponse {
3441
- /** The total number of likes of the member. */
3442
- total?: number;
3585
+ interface ConvertRichContentToDraftJsRequest {
3586
+ /**
3587
+ * Rich content to convert to DraftJs content.
3588
+ * @maxLength 2000000
3589
+ */
3590
+ richContent?: string;
3591
+ }
3592
+ interface ConvertRichContentToDraftJsResponse {
3593
+ /** DraftJs content converted from Rich content. */
3594
+ content?: Record<string, any> | null;
3443
3595
  }
3444
3596
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3445
3597
  /**
@@ -3510,25 +3662,6 @@ interface GetPostRequest {
3510
3662
  */
3511
3663
  fieldsets?: PostFieldFieldWithLiterals[];
3512
3664
  }
3513
- declare enum PostFieldField {
3514
- UNKNOWN = "UNKNOWN",
3515
- /** Includes post URL when present. */
3516
- URL = "URL",
3517
- /** Includes post content text string when present. */
3518
- CONTENT_TEXT = "CONTENT_TEXT",
3519
- /** Includes post metrics when present. */
3520
- METRICS = "METRICS",
3521
- /** Includes SEO data. */
3522
- SEO = "SEO",
3523
- /** Includes post owner's contact ID. */
3524
- CONTACT_ID = "CONTACT_ID",
3525
- /** Includes post rich content. */
3526
- RICH_CONTENT = "RICH_CONTENT",
3527
- /** Includes post reference ID field. */
3528
- REFERENCE_ID = "REFERENCE_ID"
3529
- }
3530
- /** @enumType */
3531
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3532
3665
  interface GetPostResponse {
3533
3666
  /** Retrieved post info. */
3534
3667
  post?: Post;
@@ -3621,24 +3754,6 @@ interface ListPostsRequest {
3621
3754
  */
3622
3755
  fieldsets?: PostFieldFieldWithLiterals[];
3623
3756
  }
3624
- declare enum GetPostsSort {
3625
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3626
- FEED = "FEED",
3627
- /** Ordered by `firstPublishedDate` in ascending order. */
3628
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3629
- /** Ordered by `firstPublishedDate` in descending order. */
3630
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3631
- /** Ordered by total number of views in descending order. */
3632
- VIEW_COUNT = "VIEW_COUNT",
3633
- /** Ordered by total number of likes in descending order. */
3634
- LIKE_COUNT = "LIKE_COUNT",
3635
- /** Ordered by `title` in ascending order. */
3636
- TITLE_ASC = "TITLE_ASC",
3637
- /** Ordered by `title` in descending order. */
3638
- TITLE_DESC = "TITLE_DESC"
3639
- }
3640
- /** @enumType */
3641
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3642
3757
  interface ListPostsResponse {
3643
3758
  /** List of retrieved posts. */
3644
3759
  posts?: Post[];
@@ -3988,121 +4103,6 @@ interface PostCount {
3988
4103
  /** Number of posts. */
3989
4104
  postCount?: number;
3990
4105
  }
3991
- interface ListDemoPostsRequest {
3992
- /**
3993
- * Whether to return only featured posts.
3994
- *
3995
- * Default: `false`
3996
- */
3997
- featured?: boolean;
3998
- /**
3999
- * Hashtag filter.
4000
- *
4001
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4002
- * If omitted, all posts with or without hashtags are returned.
4003
- * @maxSize 100
4004
- * @maxLength 100
4005
- */
4006
- hashtags?: string[];
4007
- /**
4008
- * Category filter.
4009
- *
4010
- * Pass an array of category IDs to return only posts with any of the provided categories.
4011
- * If omitted, all posts with or without associated categories are returned.
4012
- * @maxSize 50
4013
- * @format GUID
4014
- */
4015
- categoryIds?: string[];
4016
- /**
4017
- * Tag filter.
4018
- *
4019
- * Pass an array of tag IDs to return only posts with any of the provided tags.
4020
- * If omitted, all posts with or without tags are returned.
4021
- * @maxSize 50
4022
- * @format GUID
4023
- */
4024
- tagIds?: string[];
4025
- /**
4026
- * Sorting options.
4027
- *
4028
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4029
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4030
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4031
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4032
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4033
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
4034
- * - `TITLE_DESC`: Ordered by `title` in descending order.
4035
- * - `RATING`: reserved for internal use.
4036
- *
4037
- * Default: `FEED`
4038
- */
4039
- sort?: GetPostsSortWithLiterals;
4040
- /** Pagination options. */
4041
- paging?: BlogPaging;
4042
- /**
4043
- * __Deprecated.__ Use `fieldsets` instead.
4044
- * This parameter will be removed on June 30, 2023.
4045
- *
4046
- * List of post fields to be included in the response.
4047
- * @maxSize 20
4048
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4049
- * This parameter will be removed on June 30, 2023.
4050
- *
4051
- * List of post fields to be included in the response.
4052
- * @replacedBy fieldsets
4053
- * @targetRemovalDate 2024-06-30
4054
- */
4055
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4056
- /**
4057
- * Language filter.
4058
- *
4059
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4060
- * Pass a language to only receive posts that are in that language.
4061
- * If omitted, posts in all languages are returned.
4062
- * @format LANGUAGE_TAG
4063
- */
4064
- language?: string | null;
4065
- /**
4066
- * Post owner's member ID.
4067
- * @format GUID
4068
- */
4069
- memberId?: string | null;
4070
- /**
4071
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4072
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4073
- * only the post’s base fields are returned.
4074
- * @maxSize 20
4075
- */
4076
- fieldsets?: PostFieldFieldWithLiterals[];
4077
- }
4078
- interface ListDemoPostsResponse {
4079
- /** List of posts. */
4080
- posts?: Post[];
4081
- /** Details on the paged set of results returned. */
4082
- metaData?: MetaData;
4083
- }
4084
- interface ConvertDraftJsToRichContentRequest {
4085
- /** DraftJs content to convert to Rich content. */
4086
- content?: Record<string, any> | null;
4087
- }
4088
- interface ConvertDraftJsToRichContentResponse {
4089
- /**
4090
- * Rich content converted from DraftJs content.
4091
- * @maxLength 2000000
4092
- */
4093
- richContent?: string;
4094
- }
4095
- interface ConvertRichContentToDraftJsRequest {
4096
- /**
4097
- * Rich content to convert to DraftJs content.
4098
- * @maxLength 2000000
4099
- */
4100
- richContent?: string;
4101
- }
4102
- interface ConvertRichContentToDraftJsResponse {
4103
- /** DraftJs content converted from Rich content. */
4104
- content?: Record<string, any> | null;
4105
- }
4106
4106
  interface BaseEventMetadata {
4107
4107
  /**
4108
4108
  * App instance ID.