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