@wix/auto_sdk_blog_posts 1.0.143 → 1.0.144

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 (45) 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 +524 -533
  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 +399 -399
  7. package/build/cjs/meta.js +38 -38
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.d.ts +84 -86
  10. package/build/cjs/schemas.js +153 -151
  11. package/build/cjs/schemas.js.map +1 -1
  12. package/build/es/index.mjs +38 -38
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +524 -533
  15. package/build/es/index.typings.mjs +38 -38
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +399 -399
  18. package/build/es/meta.mjs +38 -38
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/schemas.d.mts +84 -86
  21. package/build/es/schemas.mjs +153 -151
  22. package/build/es/schemas.mjs.map +1 -1
  23. package/build/internal/cjs/index.js +38 -38
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +524 -533
  26. package/build/internal/cjs/index.typings.js +38 -38
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +399 -399
  29. package/build/internal/cjs/meta.js +38 -38
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/cjs/schemas.d.ts +84 -86
  32. package/build/internal/cjs/schemas.js +153 -151
  33. package/build/internal/cjs/schemas.js.map +1 -1
  34. package/build/internal/es/index.mjs +38 -38
  35. package/build/internal/es/index.mjs.map +1 -1
  36. package/build/internal/es/index.typings.d.mts +524 -533
  37. package/build/internal/es/index.typings.mjs +38 -38
  38. package/build/internal/es/index.typings.mjs.map +1 -1
  39. package/build/internal/es/meta.d.mts +399 -399
  40. package/build/internal/es/meta.mjs +38 -38
  41. package/build/internal/es/meta.mjs.map +1 -1
  42. package/build/internal/es/schemas.d.mts +84 -86
  43. package/build/internal/es/schemas.mjs +153 -151
  44. package/build/internal/es/schemas.mjs.map +1 -1
  45. package/package.json +2 -2
@@ -2677,292 +2677,6 @@ interface PostUnlikedInitiatorOneOf {
2677
2677
  */
2678
2678
  anonymousVisitorId?: string | null;
2679
2679
  }
2680
- interface GetTotalLikesPerMemberRequest {
2681
- /**
2682
- * Member ID.
2683
- * @format GUID
2684
- */
2685
- memberId?: string;
2686
- }
2687
- interface GetTotalLikesPerMemberResponse {
2688
- /** The total number of likes of the member. */
2689
- total?: number;
2690
- }
2691
- interface DomainEvent extends DomainEventBodyOneOf {
2692
- createdEvent?: EntityCreatedEvent;
2693
- updatedEvent?: EntityUpdatedEvent;
2694
- deletedEvent?: EntityDeletedEvent;
2695
- actionEvent?: ActionEvent;
2696
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2697
- id?: string;
2698
- /**
2699
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2700
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2701
- */
2702
- entityFqdn?: string;
2703
- /**
2704
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2705
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2706
- */
2707
- slug?: string;
2708
- /** ID of the entity associated with the event. */
2709
- entityId?: string;
2710
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2711
- eventTime?: Date | null;
2712
- /**
2713
- * Whether the event was triggered as a result of a privacy regulation application
2714
- * (for example, GDPR).
2715
- */
2716
- triggeredByAnonymizeRequest?: boolean | null;
2717
- /** If present, indicates the action that triggered the event. */
2718
- originatedFrom?: string | null;
2719
- /**
2720
- * 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.
2721
- * 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.
2722
- */
2723
- entityEventSequence?: string | null;
2724
- }
2725
- /** @oneof */
2726
- interface DomainEventBodyOneOf {
2727
- createdEvent?: EntityCreatedEvent;
2728
- updatedEvent?: EntityUpdatedEvent;
2729
- deletedEvent?: EntityDeletedEvent;
2730
- actionEvent?: ActionEvent;
2731
- }
2732
- interface EntityCreatedEvent {
2733
- entityAsJson?: string;
2734
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2735
- restoreInfo?: RestoreInfo;
2736
- }
2737
- interface RestoreInfo {
2738
- deletedDate?: Date | null;
2739
- }
2740
- interface EntityUpdatedEvent {
2741
- /**
2742
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2743
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2744
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2745
- */
2746
- currentEntityAsJson?: string;
2747
- }
2748
- interface EntityDeletedEvent {
2749
- /** Entity that was deleted. */
2750
- deletedEntityAsJson?: string | null;
2751
- }
2752
- interface ActionEvent {
2753
- bodyAsJson?: string;
2754
- }
2755
- interface MessageEnvelope {
2756
- /**
2757
- * App instance ID.
2758
- * @format GUID
2759
- */
2760
- instanceId?: string | null;
2761
- /**
2762
- * Event type.
2763
- * @maxLength 150
2764
- */
2765
- eventType?: string;
2766
- /** The identification type and identity data. */
2767
- identity?: IdentificationData;
2768
- /** Stringify payload. */
2769
- data?: string;
2770
- /** Details related to the account */
2771
- accountInfo?: AccountInfo;
2772
- }
2773
- interface IdentificationData extends IdentificationDataIdOneOf {
2774
- /**
2775
- * ID of a site visitor that has not logged in to the site.
2776
- * @format GUID
2777
- */
2778
- anonymousVisitorId?: string;
2779
- /**
2780
- * ID of a site visitor that has logged in to the site.
2781
- * @format GUID
2782
- */
2783
- memberId?: string;
2784
- /**
2785
- * ID of a Wix user (site owner, contributor, etc.).
2786
- * @format GUID
2787
- */
2788
- wixUserId?: string;
2789
- /**
2790
- * ID of an app.
2791
- * @format GUID
2792
- */
2793
- appId?: string;
2794
- /** @readonly */
2795
- identityType?: WebhookIdentityTypeWithLiterals;
2796
- }
2797
- /** @oneof */
2798
- interface IdentificationDataIdOneOf {
2799
- /**
2800
- * ID of a site visitor that has not logged in to the site.
2801
- * @format GUID
2802
- */
2803
- anonymousVisitorId?: string;
2804
- /**
2805
- * ID of a site visitor that has logged in to the site.
2806
- * @format GUID
2807
- */
2808
- memberId?: string;
2809
- /**
2810
- * ID of a Wix user (site owner, contributor, etc.).
2811
- * @format GUID
2812
- */
2813
- wixUserId?: string;
2814
- /**
2815
- * ID of an app.
2816
- * @format GUID
2817
- */
2818
- appId?: string;
2819
- }
2820
- declare enum WebhookIdentityType {
2821
- UNKNOWN = "UNKNOWN",
2822
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2823
- MEMBER = "MEMBER",
2824
- WIX_USER = "WIX_USER",
2825
- APP = "APP"
2826
- }
2827
- /** @enumType */
2828
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2829
- interface AccountInfo {
2830
- /**
2831
- * ID of the Wix account associated with the event.
2832
- * @format GUID
2833
- */
2834
- accountId?: string | null;
2835
- /**
2836
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2837
- * @format GUID
2838
- */
2839
- parentAccountId?: string | null;
2840
- /**
2841
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2842
- * @format GUID
2843
- */
2844
- siteId?: string | null;
2845
- }
2846
- /** Get Blog Publications Count Stats request */
2847
- interface QueryPublicationsCountStatsRequest {
2848
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2849
- rangeStart?: Date | null;
2850
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2851
- rangeEnd?: Date | null;
2852
- /** Order of the returned results. */
2853
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2854
- /** Number of months to include in the response. */
2855
- months?: number;
2856
- /**
2857
- * Language filter
2858
- *
2859
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2860
- * @format LANGUAGE_TAG
2861
- */
2862
- language?: string | null;
2863
- /**
2864
- * Timezone of the client.
2865
- * @minLength 3
2866
- * @maxLength 100
2867
- */
2868
- timeZone?: string | null;
2869
- }
2870
- declare enum QueryPublicationsCountStatsRequestOrder {
2871
- UNKNOWN = "UNKNOWN",
2872
- OLDEST = "OLDEST",
2873
- NEWEST = "NEWEST"
2874
- }
2875
- /** @enumType */
2876
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2877
- /** Get Blog Publications Count Stats response */
2878
- interface QueryPublicationsCountStatsResponse {
2879
- /** Chronologically ordered list of publications. */
2880
- stats?: PeriodPublicationsCount[];
2881
- }
2882
- /** Publications count for a specific time period */
2883
- interface PeriodPublicationsCount {
2884
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2885
- periodStart?: Date | null;
2886
- /** Number of posts published during this month. */
2887
- publicationsCount?: number;
2888
- }
2889
- /** Get Blog Post Count Stats request */
2890
- interface QueryPostCountStatsRequest {
2891
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2892
- rangeStart?: Date | null;
2893
- /**
2894
- * Order of returned results.
2895
- *
2896
- * - `OLDEST`: posts by date in ascending order.
2897
- * - `NEWEST`: posts by date in descending order.
2898
- *
2899
- * Default: `OLDEST`
2900
- */
2901
- order?: OrderWithLiterals;
2902
- /** Number of months to include in response. */
2903
- months?: number;
2904
- /**
2905
- * Language filter.
2906
- *
2907
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2908
- * Pass a language to only receive the period post count for that specified language.
2909
- * @format LANGUAGE_TAG
2910
- */
2911
- language?: string | null;
2912
- /**
2913
- * Time zone to use when calculating the start of the month.
2914
- *
2915
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2916
- * @minLength 3
2917
- * @maxLength 100
2918
- */
2919
- timeZone?: string | null;
2920
- }
2921
- declare enum Order {
2922
- UNKNOWN = "UNKNOWN",
2923
- OLDEST = "OLDEST",
2924
- NEWEST = "NEWEST"
2925
- }
2926
- /** @enumType */
2927
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2928
- /** Get Blog Post Count Stats response */
2929
- interface QueryPostCountStatsResponse {
2930
- /** List of published post counts by month. */
2931
- stats?: PeriodPostCount[];
2932
- }
2933
- /** Post count for a specific time period */
2934
- interface PeriodPostCount {
2935
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2936
- periodStart?: Date | null;
2937
- /** Number of posts published during this month. */
2938
- postCount?: number;
2939
- }
2940
- interface GetTotalPublicationsRequest {
2941
- /**
2942
- * Language filter
2943
- * @minLength 2
2944
- * @format LANGUAGE_TAG
2945
- */
2946
- language?: string | null;
2947
- }
2948
- interface GetTotalPublicationsResponse {
2949
- /** Total amount of publications. */
2950
- total?: number;
2951
- }
2952
- interface GetTotalPostsRequest {
2953
- /**
2954
- * Language filter.
2955
- *
2956
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2957
- * Pass a language to receive the total amount of posts in that specified language.
2958
- * @format LANGUAGE_TAG
2959
- */
2960
- language?: string | null;
2961
- }
2962
- interface GetTotalPostsResponse {
2963
- /** Total amount of published posts. */
2964
- total?: number;
2965
- }
2966
2680
  interface ListTemplatesRequest {
2967
2681
  /**
2968
2682
  * Filter post templates by given template category ids
@@ -3391,157 +3105,291 @@ interface DraftPostTranslation {
3391
3105
  /** Post URL. */
3392
3106
  url?: PageUrl;
3393
3107
  }
3394
- interface ListDemoPostsRequest {
3108
+ interface DomainEvent extends DomainEventBodyOneOf {
3109
+ createdEvent?: EntityCreatedEvent;
3110
+ updatedEvent?: EntityUpdatedEvent;
3111
+ deletedEvent?: EntityDeletedEvent;
3112
+ actionEvent?: ActionEvent;
3113
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3114
+ id?: string;
3395
3115
  /**
3396
- * Whether to return only featured posts.
3397
- *
3398
- * Default: `false`
3116
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3117
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3399
3118
  */
3400
- featured?: boolean;
3119
+ entityFqdn?: string;
3401
3120
  /**
3402
- * Hashtag filter.
3403
- *
3404
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3405
- * If omitted, all posts with or without hashtags are returned.
3406
- * @maxSize 100
3407
- * @maxLength 100
3121
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3122
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3408
3123
  */
3409
- hashtags?: string[];
3124
+ slug?: string;
3125
+ /** ID of the entity associated with the event. */
3126
+ entityId?: string;
3127
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3128
+ eventTime?: Date | null;
3410
3129
  /**
3411
- * Category filter.
3412
- *
3413
- * Pass an array of category IDs to return only posts with any of the provided categories.
3414
- * If omitted, all posts with or without associated categories are returned.
3415
- * @maxSize 50
3130
+ * Whether the event was triggered as a result of a privacy regulation application
3131
+ * (for example, GDPR).
3132
+ */
3133
+ triggeredByAnonymizeRequest?: boolean | null;
3134
+ /** If present, indicates the action that triggered the event. */
3135
+ originatedFrom?: string | null;
3136
+ /**
3137
+ * 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.
3138
+ * 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.
3139
+ */
3140
+ entityEventSequence?: string | null;
3141
+ }
3142
+ /** @oneof */
3143
+ interface DomainEventBodyOneOf {
3144
+ createdEvent?: EntityCreatedEvent;
3145
+ updatedEvent?: EntityUpdatedEvent;
3146
+ deletedEvent?: EntityDeletedEvent;
3147
+ actionEvent?: ActionEvent;
3148
+ }
3149
+ interface EntityCreatedEvent {
3150
+ entityAsJson?: string;
3151
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3152
+ restoreInfo?: RestoreInfo;
3153
+ }
3154
+ interface RestoreInfo {
3155
+ deletedDate?: Date | null;
3156
+ }
3157
+ interface EntityUpdatedEvent {
3158
+ /**
3159
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3160
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3161
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3162
+ */
3163
+ currentEntityAsJson?: string;
3164
+ }
3165
+ interface EntityDeletedEvent {
3166
+ /** Entity that was deleted. */
3167
+ deletedEntityAsJson?: string | null;
3168
+ }
3169
+ interface ActionEvent {
3170
+ bodyAsJson?: string;
3171
+ }
3172
+ interface MessageEnvelope {
3173
+ /**
3174
+ * App instance ID.
3416
3175
  * @format GUID
3417
3176
  */
3418
- categoryIds?: string[];
3177
+ instanceId?: string | null;
3419
3178
  /**
3420
- * Tag filter.
3421
- *
3422
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3423
- * If omitted, all posts with or without tags are returned.
3424
- * @maxSize 50
3179
+ * Event type.
3180
+ * @maxLength 150
3181
+ */
3182
+ eventType?: string;
3183
+ /** The identification type and identity data. */
3184
+ identity?: IdentificationData;
3185
+ /** Stringify payload. */
3186
+ data?: string;
3187
+ /** Details related to the account */
3188
+ accountInfo?: AccountInfo;
3189
+ }
3190
+ interface IdentificationData extends IdentificationDataIdOneOf {
3191
+ /**
3192
+ * ID of a site visitor that has not logged in to the site.
3425
3193
  * @format GUID
3426
3194
  */
3427
- tagIds?: string[];
3195
+ anonymousVisitorId?: string;
3428
3196
  /**
3429
- * Sorting options.
3430
- *
3431
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3432
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3433
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3434
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3435
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3436
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3437
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3438
- * - `RATING`: reserved for internal use.
3197
+ * ID of a site visitor that has logged in to the site.
3198
+ * @format GUID
3199
+ */
3200
+ memberId?: string;
3201
+ /**
3202
+ * ID of a Wix user (site owner, contributor, etc.).
3203
+ * @format GUID
3204
+ */
3205
+ wixUserId?: string;
3206
+ /**
3207
+ * ID of an app.
3208
+ * @format GUID
3209
+ */
3210
+ appId?: string;
3211
+ /** @readonly */
3212
+ identityType?: WebhookIdentityTypeWithLiterals;
3213
+ }
3214
+ /** @oneof */
3215
+ interface IdentificationDataIdOneOf {
3216
+ /**
3217
+ * ID of a site visitor that has not logged in to the site.
3218
+ * @format GUID
3219
+ */
3220
+ anonymousVisitorId?: string;
3221
+ /**
3222
+ * ID of a site visitor that has logged in to the site.
3223
+ * @format GUID
3224
+ */
3225
+ memberId?: string;
3226
+ /**
3227
+ * ID of a Wix user (site owner, contributor, etc.).
3228
+ * @format GUID
3229
+ */
3230
+ wixUserId?: string;
3231
+ /**
3232
+ * ID of an app.
3233
+ * @format GUID
3234
+ */
3235
+ appId?: string;
3236
+ }
3237
+ declare enum WebhookIdentityType {
3238
+ UNKNOWN = "UNKNOWN",
3239
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3240
+ MEMBER = "MEMBER",
3241
+ WIX_USER = "WIX_USER",
3242
+ APP = "APP"
3243
+ }
3244
+ /** @enumType */
3245
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3246
+ interface AccountInfo {
3247
+ /**
3248
+ * ID of the Wix account associated with the event.
3249
+ * @format GUID
3250
+ */
3251
+ accountId?: string | null;
3252
+ /**
3253
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
3254
+ * @format GUID
3255
+ */
3256
+ parentAccountId?: string | null;
3257
+ /**
3258
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3259
+ * @format GUID
3260
+ */
3261
+ siteId?: string | null;
3262
+ }
3263
+ /** Get Blog Publications Count Stats request */
3264
+ interface QueryPublicationsCountStatsRequest {
3265
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3266
+ rangeStart?: Date | null;
3267
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3268
+ rangeEnd?: Date | null;
3269
+ /** Order of the returned results. */
3270
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3271
+ /** Number of months to include in the response. */
3272
+ months?: number;
3273
+ /**
3274
+ * Language filter
3439
3275
  *
3440
- * Default: `FEED`
3276
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3277
+ * @format LANGUAGE_TAG
3441
3278
  */
3442
- sort?: GetPostsSortWithLiterals;
3443
- /** Pagination options. */
3444
- paging?: BlogPaging;
3279
+ language?: string | null;
3445
3280
  /**
3446
- * __Deprecated.__ Use `fieldsets` instead.
3447
- * This parameter will be removed on June 30, 2023.
3281
+ * Timezone of the client.
3282
+ * @minLength 3
3283
+ * @maxLength 100
3284
+ */
3285
+ timeZone?: string | null;
3286
+ }
3287
+ declare enum QueryPublicationsCountStatsRequestOrder {
3288
+ UNKNOWN = "UNKNOWN",
3289
+ OLDEST = "OLDEST",
3290
+ NEWEST = "NEWEST"
3291
+ }
3292
+ /** @enumType */
3293
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3294
+ /** Get Blog Publications Count Stats response */
3295
+ interface QueryPublicationsCountStatsResponse {
3296
+ /** Chronologically ordered list of publications. */
3297
+ stats?: PeriodPublicationsCount[];
3298
+ }
3299
+ /** Publications count for a specific time period */
3300
+ interface PeriodPublicationsCount {
3301
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3302
+ periodStart?: Date | null;
3303
+ /** Number of posts published during this month. */
3304
+ publicationsCount?: number;
3305
+ }
3306
+ /** Get Blog Post Count Stats request */
3307
+ interface QueryPostCountStatsRequest {
3308
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3309
+ rangeStart?: Date | null;
3310
+ /**
3311
+ * Order of returned results.
3448
3312
  *
3449
- * List of post fields to be included in the response.
3450
- * @maxSize 20
3451
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
3452
- * This parameter will be removed on June 30, 2023.
3313
+ * - `OLDEST`: posts by date in ascending order.
3314
+ * - `NEWEST`: posts by date in descending order.
3453
3315
  *
3454
- * List of post fields to be included in the response.
3455
- * @replacedBy fieldsets
3456
- * @targetRemovalDate 2024-06-30
3316
+ * Default: `OLDEST`
3457
3317
  */
3458
- fieldsToInclude?: PostFieldFieldWithLiterals[];
3318
+ order?: OrderWithLiterals;
3319
+ /** Number of months to include in response. */
3320
+ months?: number;
3459
3321
  /**
3460
3322
  * Language filter.
3461
3323
  *
3462
3324
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3463
- * Pass a language to only receive posts that are in that language.
3464
- * If omitted, posts in all languages are returned.
3325
+ * Pass a language to only receive the period post count for that specified language.
3465
3326
  * @format LANGUAGE_TAG
3466
3327
  */
3467
3328
  language?: string | null;
3468
3329
  /**
3469
- * Post owner's member ID.
3470
- * @format GUID
3471
- */
3472
- memberId?: string | null;
3473
- /**
3474
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3475
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3476
- * only the post’s base fields are returned.
3477
- * @maxSize 20
3330
+ * Time zone to use when calculating the start of the month.
3331
+ *
3332
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3333
+ * @minLength 3
3334
+ * @maxLength 100
3478
3335
  */
3479
- fieldsets?: PostFieldFieldWithLiterals[];
3480
- }
3481
- declare enum GetPostsSort {
3482
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3483
- FEED = "FEED",
3484
- /** Ordered by `firstPublishedDate` in ascending order. */
3485
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3486
- /** Ordered by `firstPublishedDate` in descending order. */
3487
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3488
- /** Ordered by total number of views in descending order. */
3489
- VIEW_COUNT = "VIEW_COUNT",
3490
- /** Ordered by total number of likes in descending order. */
3491
- LIKE_COUNT = "LIKE_COUNT",
3492
- /** Ordered by `title` in ascending order. */
3493
- TITLE_ASC = "TITLE_ASC",
3494
- /** Ordered by `title` in descending order. */
3495
- TITLE_DESC = "TITLE_DESC"
3336
+ timeZone?: string | null;
3496
3337
  }
3497
- /** @enumType */
3498
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3499
- declare enum PostFieldField {
3338
+ declare enum Order {
3500
3339
  UNKNOWN = "UNKNOWN",
3501
- /** Includes post URL when present. */
3502
- URL = "URL",
3503
- /** Includes post content text string when present. */
3504
- CONTENT_TEXT = "CONTENT_TEXT",
3505
- /** Includes post metrics when present. */
3506
- METRICS = "METRICS",
3507
- /** Includes SEO data. */
3508
- SEO = "SEO",
3509
- /** Includes post owner's contact ID. */
3510
- CONTACT_ID = "CONTACT_ID",
3511
- /** Includes post rich content. */
3512
- RICH_CONTENT = "RICH_CONTENT",
3513
- /** Includes post reference ID field. */
3514
- REFERENCE_ID = "REFERENCE_ID"
3340
+ OLDEST = "OLDEST",
3341
+ NEWEST = "NEWEST"
3515
3342
  }
3516
3343
  /** @enumType */
3517
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3518
- interface ListDemoPostsResponse {
3519
- /** List of posts. */
3520
- posts?: Post[];
3521
- /** Details on the paged set of results returned. */
3522
- metaData?: MetaData;
3344
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3345
+ /** Get Blog Post Count Stats response */
3346
+ interface QueryPostCountStatsResponse {
3347
+ /** List of published post counts by month. */
3348
+ stats?: PeriodPostCount[];
3523
3349
  }
3524
- interface ConvertDraftJsToRichContentRequest {
3525
- /** DraftJs content to convert to Rich content. */
3526
- content?: Record<string, any> | null;
3350
+ /** Post count for a specific time period */
3351
+ interface PeriodPostCount {
3352
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3353
+ periodStart?: Date | null;
3354
+ /** Number of posts published during this month. */
3355
+ postCount?: number;
3527
3356
  }
3528
- interface ConvertDraftJsToRichContentResponse {
3357
+ interface GetTotalPublicationsRequest {
3529
3358
  /**
3530
- * Rich content converted from DraftJs content.
3531
- * @maxLength 2000000
3359
+ * Language filter
3360
+ * @minLength 2
3361
+ * @format LANGUAGE_TAG
3532
3362
  */
3533
- richContent?: string;
3363
+ language?: string | null;
3534
3364
  }
3535
- interface ConvertRichContentToDraftJsRequest {
3365
+ interface GetTotalPublicationsResponse {
3366
+ /** Total amount of publications. */
3367
+ total?: number;
3368
+ }
3369
+ interface GetTotalPostsRequest {
3536
3370
  /**
3537
- * Rich content to convert to DraftJs content.
3538
- * @maxLength 2000000
3371
+ * Language filter.
3372
+ *
3373
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3374
+ * Pass a language to receive the total amount of posts in that specified language.
3375
+ * @format LANGUAGE_TAG
3539
3376
  */
3540
- richContent?: string;
3377
+ language?: string | null;
3541
3378
  }
3542
- interface ConvertRichContentToDraftJsResponse {
3543
- /** DraftJs content converted from Rich content. */
3544
- content?: Record<string, any> | null;
3379
+ interface GetTotalPostsResponse {
3380
+ /** Total amount of published posts. */
3381
+ total?: number;
3382
+ }
3383
+ interface GetTotalLikesPerMemberRequest {
3384
+ /**
3385
+ * Member ID.
3386
+ * @format GUID
3387
+ */
3388
+ memberId?: string;
3389
+ }
3390
+ interface GetTotalLikesPerMemberResponse {
3391
+ /** The total number of likes of the member. */
3392
+ total?: number;
3545
3393
  }
3546
3394
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3547
3395
  /**
@@ -3612,6 +3460,25 @@ interface GetPostRequest {
3612
3460
  */
3613
3461
  fieldsets?: PostFieldFieldWithLiterals[];
3614
3462
  }
3463
+ declare enum PostFieldField {
3464
+ UNKNOWN = "UNKNOWN",
3465
+ /** Includes post URL when present. */
3466
+ URL = "URL",
3467
+ /** Includes post content text string when present. */
3468
+ CONTENT_TEXT = "CONTENT_TEXT",
3469
+ /** Includes post metrics when present. */
3470
+ METRICS = "METRICS",
3471
+ /** Includes SEO data. */
3472
+ SEO = "SEO",
3473
+ /** Includes post owner's contact ID. */
3474
+ CONTACT_ID = "CONTACT_ID",
3475
+ /** Includes post rich content. */
3476
+ RICH_CONTENT = "RICH_CONTENT",
3477
+ /** Includes post reference ID field. */
3478
+ REFERENCE_ID = "REFERENCE_ID"
3479
+ }
3480
+ /** @enumType */
3481
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3615
3482
  interface GetPostResponse {
3616
3483
  /** Retrieved post info. */
3617
3484
  post?: Post;
@@ -3704,6 +3571,24 @@ interface ListPostsRequest {
3704
3571
  */
3705
3572
  fieldsets?: PostFieldFieldWithLiterals[];
3706
3573
  }
3574
+ declare enum GetPostsSort {
3575
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3576
+ FEED = "FEED",
3577
+ /** Ordered by `firstPublishedDate` in ascending order. */
3578
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3579
+ /** Ordered by `firstPublishedDate` in descending order. */
3580
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3581
+ /** Ordered by total number of views in descending order. */
3582
+ VIEW_COUNT = "VIEW_COUNT",
3583
+ /** Ordered by total number of likes in descending order. */
3584
+ LIKE_COUNT = "LIKE_COUNT",
3585
+ /** Ordered by `title` in ascending order. */
3586
+ TITLE_ASC = "TITLE_ASC",
3587
+ /** Ordered by `title` in descending order. */
3588
+ TITLE_DESC = "TITLE_DESC"
3589
+ }
3590
+ /** @enumType */
3591
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3707
3592
  interface ListPostsResponse {
3708
3593
  /** List of retrieved posts. */
3709
3594
  posts?: Post[];
@@ -4053,6 +3938,121 @@ interface PostCount {
4053
3938
  /** Number of posts. */
4054
3939
  postCount?: number;
4055
3940
  }
3941
+ interface ListDemoPostsRequest {
3942
+ /**
3943
+ * Whether to return only featured posts.
3944
+ *
3945
+ * Default: `false`
3946
+ */
3947
+ featured?: boolean;
3948
+ /**
3949
+ * Hashtag filter.
3950
+ *
3951
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3952
+ * If omitted, all posts with or without hashtags are returned.
3953
+ * @maxSize 100
3954
+ * @maxLength 100
3955
+ */
3956
+ hashtags?: string[];
3957
+ /**
3958
+ * Category filter.
3959
+ *
3960
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3961
+ * If omitted, all posts with or without associated categories are returned.
3962
+ * @maxSize 50
3963
+ * @format GUID
3964
+ */
3965
+ categoryIds?: string[];
3966
+ /**
3967
+ * Tag filter.
3968
+ *
3969
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3970
+ * If omitted, all posts with or without tags are returned.
3971
+ * @maxSize 50
3972
+ * @format GUID
3973
+ */
3974
+ tagIds?: string[];
3975
+ /**
3976
+ * Sorting options.
3977
+ *
3978
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3979
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3980
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3981
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3982
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3983
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3984
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3985
+ * - `RATING`: reserved for internal use.
3986
+ *
3987
+ * Default: `FEED`
3988
+ */
3989
+ sort?: GetPostsSortWithLiterals;
3990
+ /** Pagination options. */
3991
+ paging?: BlogPaging;
3992
+ /**
3993
+ * __Deprecated.__ Use `fieldsets` instead.
3994
+ * This parameter will be removed on June 30, 2023.
3995
+ *
3996
+ * List of post fields to be included in the response.
3997
+ * @maxSize 20
3998
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3999
+ * This parameter will be removed on June 30, 2023.
4000
+ *
4001
+ * List of post fields to be included in the response.
4002
+ * @replacedBy fieldsets
4003
+ * @targetRemovalDate 2024-06-30
4004
+ */
4005
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
4006
+ /**
4007
+ * Language filter.
4008
+ *
4009
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4010
+ * Pass a language to only receive posts that are in that language.
4011
+ * If omitted, posts in all languages are returned.
4012
+ * @format LANGUAGE_TAG
4013
+ */
4014
+ language?: string | null;
4015
+ /**
4016
+ * Post owner's member ID.
4017
+ * @format GUID
4018
+ */
4019
+ memberId?: string | null;
4020
+ /**
4021
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4022
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4023
+ * only the post’s base fields are returned.
4024
+ * @maxSize 20
4025
+ */
4026
+ fieldsets?: PostFieldFieldWithLiterals[];
4027
+ }
4028
+ interface ListDemoPostsResponse {
4029
+ /** List of posts. */
4030
+ posts?: Post[];
4031
+ /** Details on the paged set of results returned. */
4032
+ metaData?: MetaData;
4033
+ }
4034
+ interface ConvertDraftJsToRichContentRequest {
4035
+ /** DraftJs content to convert to Rich content. */
4036
+ content?: Record<string, any> | null;
4037
+ }
4038
+ interface ConvertDraftJsToRichContentResponse {
4039
+ /**
4040
+ * Rich content converted from DraftJs content.
4041
+ * @maxLength 2000000
4042
+ */
4043
+ richContent?: string;
4044
+ }
4045
+ interface ConvertRichContentToDraftJsRequest {
4046
+ /**
4047
+ * Rich content to convert to DraftJs content.
4048
+ * @maxLength 2000000
4049
+ */
4050
+ richContent?: string;
4051
+ }
4052
+ interface ConvertRichContentToDraftJsResponse {
4053
+ /** DraftJs content converted from Rich content. */
4054
+ content?: Record<string, any> | null;
4055
+ }
4056
4056
 
4057
4057
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4058
4058
  getUrl: (context: any) => string;