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