@wix/auto_sdk_blog_posts 1.0.166 → 1.0.168

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 (41) hide show
  1. package/build/cjs/index.d.ts +1 -1
  2. package/build/cjs/index.js +49 -18
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +223 -167
  5. package/build/cjs/index.typings.js +49 -18
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +223 -167
  8. package/build/cjs/meta.js +49 -18
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +2 -2
  11. package/build/es/index.d.mts +1 -1
  12. package/build/es/index.mjs +48 -18
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +223 -167
  15. package/build/es/index.typings.mjs +48 -18
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +223 -167
  18. package/build/es/meta.mjs +48 -18
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/schemas.d.mts +2 -2
  21. package/build/internal/cjs/index.d.ts +1 -1
  22. package/build/internal/cjs/index.js +49 -18
  23. package/build/internal/cjs/index.js.map +1 -1
  24. package/build/internal/cjs/index.typings.d.ts +694 -171
  25. package/build/internal/cjs/index.typings.js +49 -18
  26. package/build/internal/cjs/index.typings.js.map +1 -1
  27. package/build/internal/cjs/meta.d.ts +748 -176
  28. package/build/internal/cjs/meta.js +49 -18
  29. package/build/internal/cjs/meta.js.map +1 -1
  30. package/build/internal/cjs/schemas.d.ts +2 -2
  31. package/build/internal/es/index.d.mts +1 -1
  32. package/build/internal/es/index.mjs +48 -18
  33. package/build/internal/es/index.mjs.map +1 -1
  34. package/build/internal/es/index.typings.d.mts +694 -171
  35. package/build/internal/es/index.typings.mjs +48 -18
  36. package/build/internal/es/index.typings.mjs.map +1 -1
  37. package/build/internal/es/meta.d.mts +748 -176
  38. package/build/internal/es/meta.mjs +48 -18
  39. package/build/internal/es/meta.mjs.map +1 -1
  40. package/build/internal/es/schemas.d.mts +2 -2
  41. package/package.json +4 -4
@@ -65,6 +65,14 @@ interface Post {
65
65
  hashtags?: string[];
66
66
  /** Whether commenting on the post is enabled. */
67
67
  commentingEnabled?: boolean;
68
+ /**
69
+ * Dynamic post count info Comment Count, Like Count, View Count.
70
+ * @internal
71
+ * @deprecated Dynamic post count info Comment Count, Like Count, View Count.
72
+ * @replacedBy metrics
73
+ * @targetRemovalDate 2024-06-30
74
+ */
75
+ postCountInfo?: PostCountInfo;
68
76
  /** Estimated reading time (calculated automatically). */
69
77
  minutesToRead?: number;
70
78
  /** Image placed at the top of the blog page. Only displays on mobile devices. */
@@ -104,8 +112,22 @@ interface Post {
104
112
  * @format LANGUAGE_TAG
105
113
  */
106
114
  language?: string | null;
115
+ /**
116
+ * Post metrics.
117
+ * Deprecated on '2022-02-15', data can be inconsistent, for consistent data please use 'PostService#GetPostMetrics' API instead
118
+ * @internal
119
+ * @deprecated
120
+ */
121
+ metrics?: Metrics;
107
122
  /** SEO data. */
108
123
  seoData?: SeoSchema;
124
+ /**
125
+ * Reserved for internal use.
126
+ * @internal
127
+ * @readonly
128
+ * @maxLength 400000
129
+ */
130
+ content?: string | null;
109
131
  /**
110
132
  * Contact ID of the post's owner. See the Contacts API for more info.
111
133
  * @format GUID
@@ -126,6 +148,19 @@ interface Post {
126
148
  * @readonly
127
149
  */
128
150
  preview?: boolean;
151
+ /**
152
+ * Reserved for internal use.
153
+ * @internal
154
+ * @maxLength 24
155
+ */
156
+ contentId?: string | null;
157
+ /**
158
+ * Reserved for internal use.
159
+ * @internal
160
+ * @readonly
161
+ * @format GUID
162
+ */
163
+ mostRecentContributorId?: string | null;
129
164
  /**
130
165
  * Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).
131
166
  *
@@ -142,17 +177,68 @@ interface Post {
142
177
  * @maxLength 8000000
143
178
  */
144
179
  richContentString?: string | null;
180
+ /**
181
+ * Post rich content as compressed binary data
182
+ * @internal
183
+ * @readonly
184
+ */
185
+ richContentCompressed?: Uint8Array | null;
145
186
  /**
146
187
  * Indicates if there is a draft post with changes that have not yet been published.
147
188
  * @readonly
148
189
  */
149
190
  hasUnpublishedChanges?: boolean;
191
+ /**
192
+ * List of the post's translated posts.
193
+ * @internal
194
+ * @readonly
195
+ * @maxSize 1000
196
+ */
197
+ translations?: PostTranslation[];
198
+ /**
199
+ * Identifies whether excerpt was set by contributor.
200
+ * True - excerpt was set by contributor.
201
+ * False - excerpt was generated from content.
202
+ * @internal
203
+ * @readonly
204
+ */
205
+ customExcerpt?: boolean;
150
206
  /**
151
207
  * Post reference ID. You can reference the post from other entities, for example, comments.
152
208
  * @readonly
153
209
  * @maxLength 24
154
210
  */
155
211
  referenceId?: string | null;
212
+ /**
213
+ * Reserved for internal use.
214
+ * @internal
215
+ * @readonly
216
+ * @maxLength 24
217
+ */
218
+ internalId?: string | null;
219
+ /**
220
+ * Reserved for internal use.
221
+ * @internal
222
+ * @readonly
223
+ * @maxSize 10
224
+ * @maxLength 24
225
+ */
226
+ internalCategoryIds?: string[];
227
+ /**
228
+ * Reserved for internal use.
229
+ * @internal
230
+ * @readonly
231
+ * @maxSize 3
232
+ * @maxLength 24
233
+ */
234
+ internalRelatedPostIds?: string[];
235
+ /**
236
+ * Identifies if post is created from template
237
+ * Reserved for internal use.
238
+ * @internal
239
+ * @readonly
240
+ */
241
+ isDemo?: boolean | null;
156
242
  }
157
243
  interface PostCountInfo {
158
244
  /**
@@ -197,6 +283,18 @@ interface Metrics {
197
283
  * @readonly
198
284
  */
199
285
  views?: number;
286
+ /**
287
+ * Total number of post ratings.
288
+ * @internal
289
+ * @readonly
290
+ */
291
+ totalRatings?: number;
292
+ /**
293
+ * Average rating of post from 1 to 5.
294
+ * @internal
295
+ * @readonly
296
+ */
297
+ averageRating?: number;
200
298
  }
201
299
  /**
202
300
  * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
@@ -763,6 +861,8 @@ interface Animation {
763
861
  type?: TypeWithLiterals;
764
862
  /** Entrance animation, played once when the node first enters the viewport. */
765
863
  entrance?: EntranceAnimation;
864
+ /** Looping animation, repeated indefinitely while the node is on the page. When combined with entrance, the loop starts after the entrance finishes. */
865
+ loop?: LoopAnimation;
766
866
  }
767
867
  declare enum Type {
768
868
  /** Animations that play while the node is in view. */
@@ -837,6 +937,58 @@ declare enum EntranceEffectType {
837
937
  }
838
938
  /** @enumType */
839
939
  type EntranceEffectTypeWithLiterals = EntranceEffectType | 'FADE' | 'ARC' | 'BLUR' | 'BOUNCE' | 'DROP' | 'EXPAND' | 'FLIP' | 'FLOAT' | 'FOLD' | 'GLIDE' | 'REVEAL' | 'SHAPE' | 'SHUTTERS' | 'SLIDE' | 'SPIN' | 'TILT' | 'TURN' | 'WINK';
940
+ interface LoopAnimation {
941
+ /** The looping effect to repeat. */
942
+ effect?: LoopEffect;
943
+ /** Duration of a single iteration in milliseconds. Each effect has its own default. */
944
+ duration?: number | null;
945
+ /** Pause between iterations in milliseconds. */
946
+ iterationDelay?: number | null;
947
+ }
948
+ interface LoopEffect {
949
+ /** The looping effect type. */
950
+ type?: LoopEffectTypeWithLiterals;
951
+ /**
952
+ * Direction of the effect. Allowed values depend on the effect type (e.g. TOP/RIGHT/BOTTOM/LEFT, LEFT/RIGHT, HORIZONTAL/VERTICAL with or without CENTER, CLOCKWISE/COUNTER_CLOCKWISE).
953
+ * @maxLength 20
954
+ */
955
+ direction?: string | null;
956
+ /**
957
+ * Motion style: GENTLE, MODERATE, or INTENSE. Only the effects that expose one accept it.
958
+ * @maxLength 100
959
+ */
960
+ easing?: string | null;
961
+ }
962
+ declare enum LoopEffectType {
963
+ /** Bounces up and down in place. */
964
+ BOUNCE = "BOUNCE",
965
+ /** Scales gently in and out along an axis. */
966
+ BREATHE = "BREATHE",
967
+ /** Drifts toward one side, then re-enters from the opposite side. */
968
+ CROSS = "CROSS",
969
+ /** Fades out to fully transparent and back in. */
970
+ FLASH = "FLASH",
971
+ /** Rotates a full turn around its horizontal or vertical axis. */
972
+ FLIP = "FLIP",
973
+ /** Folds back and forth around a hinged edge. */
974
+ FOLD = "FOLD",
975
+ /** Wobbles with a jelly-like skew. */
976
+ JELLO = "JELLO",
977
+ /** Nudges repeatedly toward a direction. */
978
+ POKE = "POKE",
979
+ /** Scales up and back down rhythmically. */
980
+ PULSE = "PULSE",
981
+ /** Stretches and squashes like a rubber band. */
982
+ RUBBER = "RUBBER",
983
+ /** Rotates continuously around its center. */
984
+ SPIN = "SPIN",
985
+ /** Swings back and forth around an edge pivot. */
986
+ SWING = "SWING",
987
+ /** Rocks side to side with an accumulating rotation. */
988
+ WIGGLE = "WIGGLE"
989
+ }
990
+ /** @enumType */
991
+ type LoopEffectTypeWithLiterals = LoopEffectType | 'BOUNCE' | 'BREATHE' | 'CROSS' | 'FLASH' | 'FLIP' | 'FOLD' | 'JELLO' | 'POKE' | 'PULSE' | 'RUBBER' | 'SPIN' | 'SWING' | 'WIGGLE';
840
992
  interface CodeBlockData {
841
993
  /** Styling for the code block's text. */
842
994
  textStyle?: TextStyle;
@@ -1693,6 +1845,8 @@ interface MentionData {
1693
1845
  slug?: string;
1694
1846
  /** Mentioned user's ID. */
1695
1847
  id?: string | null;
1848
+ /** The kind of entity the mention refers to. Any value is accepted, and it's usually used to mark a mention as a group mention (for example, `group`). When empty, the mention refers to a member. */
1849
+ type?: string | null;
1696
1850
  }
1697
1851
  interface FontSizeData {
1698
1852
  /** The units used for the font size. */
@@ -2854,8 +3008,68 @@ interface VideoResolution {
2854
3008
  height?: number;
2855
3009
  /** Video width. */
2856
3010
  width?: number;
3011
+ /**
3012
+ * Deprecated. Use the `posters` property in the parent entity instead.
3013
+ * @internal
3014
+ * @deprecated
3015
+ */
3016
+ poster?: string;
2857
3017
  /** Video format for example, mp4, hls. */
2858
3018
  format?: string;
3019
+ /**
3020
+ * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
3021
+ * @internal
3022
+ * @deprecated
3023
+ */
3024
+ urlExpirationDate?: Date | null;
3025
+ /**
3026
+ * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
3027
+ * @internal
3028
+ * @format DECIMAL_VALUE
3029
+ * @deprecated
3030
+ */
3031
+ sizeInBytes?: string | null;
3032
+ /**
3033
+ * Video quality. For example: 480p, 720p.
3034
+ * @internal
3035
+ */
3036
+ quality?: string | null;
3037
+ /**
3038
+ * Video filename.
3039
+ * @internal
3040
+ */
3041
+ filename?: string | null;
3042
+ /**
3043
+ * Video duration in seconds.
3044
+ * @internal
3045
+ * @readonly
3046
+ * @deprecated Video duration in seconds.
3047
+ * @replacedBy duration_in_milliseconds
3048
+ * @targetRemovalDate 2024-08-01
3049
+ */
3050
+ durationInSeconds?: number | null;
3051
+ /**
3052
+ * Video duration in milliseconds.
3053
+ * @internal
3054
+ * @readonly
3055
+ */
3056
+ durationInMilliseconds?: number | null;
3057
+ /**
3058
+ * When true, this is a protected asset, and calling the URL will return a 403 error.
3059
+ * In order to access private assets, make a request to:
3060
+ * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
3061
+ * @internal
3062
+ * @readonly
3063
+ */
3064
+ private?: boolean | null;
3065
+ /**
3066
+ * Key to identify the video resolution's relationship to the original media in WixMedia.
3067
+ * Can be used to request a download for the specific video resolution.
3068
+ * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
3069
+ * @internal
3070
+ * @readonly
3071
+ */
3072
+ assetKey?: string | null;
2859
3073
  }
2860
3074
  interface EmbedMedia {
2861
3075
  /** Thumbnail details. */
@@ -3226,6 +3440,20 @@ interface PeriodPublicationsCount {
3226
3440
  interface QueryPostCountStatsRequest {
3227
3441
  /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3228
3442
  rangeStart?: Date | null;
3443
+ /**
3444
+ * __Deprecated.__ Use `months` instead.
3445
+ * This property will be removed on June 30, 2023.
3446
+ *
3447
+ * Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format.
3448
+ * @internal
3449
+ * @deprecated __Deprecated.__ Use `months` instead.
3450
+ * This property will be removed on June 30, 2023.
3451
+ *
3452
+ * Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format.
3453
+ * @replacedBy months
3454
+ * @targetRemovalDate 2024-06-30
3455
+ */
3456
+ rangeEnd?: Date | null;
3229
3457
  /**
3230
3458
  * Order of returned results.
3231
3459
  *
@@ -3299,62 +3527,91 @@ interface GetTotalPostsResponse {
3299
3527
  /** Total amount of published posts. */
3300
3528
  total?: number;
3301
3529
  }
3302
- interface ListDemoPostsRequest {
3530
+ interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3303
3531
  /**
3304
- * Whether to return only featured posts.
3305
- *
3306
- * Default: `false`
3532
+ * Member ID of person who triggered the counter update
3533
+ * @format GUID
3307
3534
  */
3308
- featured?: boolean;
3535
+ memberId?: string | null;
3309
3536
  /**
3310
- * Hashtag filter.
3311
- *
3312
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3313
- * If omitted, all posts with or without hashtags are returned.
3314
- * @maxSize 100
3315
- * @maxLength 100
3537
+ * Visitor ID if person that liked the post is not logged in
3538
+ * @format GUID
3316
3539
  */
3317
- hashtags?: string[];
3540
+ anonymousVisitorId?: string | null;
3318
3541
  /**
3319
- * Category filter.
3320
- *
3321
- * Pass an array of category IDs to return only posts with any of the provided categories.
3322
- * If omitted, all posts with or without associated categories are returned.
3323
- * @maxSize 50
3542
+ * ID of the post which counters were updated.
3324
3543
  * @format GUID
3325
3544
  */
3326
- categoryIds?: string[];
3545
+ postId?: string;
3327
3546
  /**
3328
- * Tag filter.
3329
- *
3330
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3331
- * If omitted, all posts with or without tags are returned.
3332
- * @maxSize 50
3547
+ * Internal ID of the post which counters were updated.
3548
+ * @internal
3549
+ * @maxLength 24
3550
+ */
3551
+ postInternalId?: string;
3552
+ /** Field of the updated counter. */
3553
+ updatedCounterField?: FieldWithLiterals;
3554
+ /** New counter value. */
3555
+ counter?: number;
3556
+ }
3557
+ /** @oneof */
3558
+ interface PostCountersUpdatedInitiatorOneOf {
3559
+ /**
3560
+ * Member ID of person who triggered the counter update
3333
3561
  * @format GUID
3334
3562
  */
3335
- tagIds?: string[];
3563
+ memberId?: string | null;
3336
3564
  /**
3337
- * Sorting options.
3338
- *
3339
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3340
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3341
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3342
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3343
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3344
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3345
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3346
- * - `RATING`: reserved for internal use.
3347
- *
3348
- * Default: `FEED`
3565
+ * Visitor ID if person that liked the post is not logged in
3566
+ * @format GUID
3349
3567
  */
3350
- sort?: GetPostsSortWithLiterals;
3351
- /** Pagination options. */
3352
- paging?: BlogPaging;
3568
+ anonymousVisitorId?: string | null;
3569
+ }
3570
+ declare enum Field {
3571
+ /** Undefined field. */
3572
+ UNKNOWN = "UNKNOWN",
3573
+ /** Total comments field. */
3574
+ TOTAL_COMMENTS = "TOTAL_COMMENTS",
3575
+ /** Like count field. */
3576
+ LIKE_COUNT = "LIKE_COUNT",
3577
+ /** View count field. */
3578
+ VIEW_COUNT = "VIEW_COUNT",
3579
+ /** Rating count field. */
3580
+ RATING_COUNT = "RATING_COUNT"
3581
+ }
3582
+ /** @enumType */
3583
+ type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
3584
+ interface PostOwnerChanged {
3585
+ /**
3586
+ * Member ID of the post's owner before the change.
3587
+ * @internal
3588
+ * @format GUID
3589
+ */
3590
+ oldMemberId?: string;
3591
+ /**
3592
+ * Member ID of the post's owner after the change.
3593
+ * @internal
3594
+ * @format GUID
3595
+ */
3596
+ newMemberId?: string;
3597
+ }
3598
+ interface InitialPostsCopied {
3599
+ /** Number of posts copied. */
3600
+ count?: number;
3601
+ }
3602
+ interface GetPostRequest {
3603
+ /**
3604
+ * Post ID.
3605
+ * @minLength 1
3606
+ * @maxLength 38
3607
+ */
3608
+ postId: string;
3353
3609
  /**
3354
3610
  * __Deprecated.__ Use `fieldsets` instead.
3355
3611
  * This parameter will be removed on June 30, 2023.
3356
3612
  *
3357
3613
  * List of post fields to be included in the response.
3614
+ * @internal
3358
3615
  * @maxSize 20
3359
3616
  * @deprecated __Deprecated.__ Use `fieldsets` instead.
3360
3617
  * This parameter will be removed on June 30, 2023.
@@ -3364,20 +3621,6 @@ interface ListDemoPostsRequest {
3364
3621
  * @targetRemovalDate 2024-06-30
3365
3622
  */
3366
3623
  fieldsToInclude?: PostFieldFieldWithLiterals[];
3367
- /**
3368
- * Language filter.
3369
- *
3370
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3371
- * Pass a language to only receive posts that are in that language.
3372
- * If omitted, posts in all languages are returned.
3373
- * @format LANGUAGE_TAG
3374
- */
3375
- language?: string | null;
3376
- /**
3377
- * Post owner's member ID.
3378
- * @format GUID
3379
- */
3380
- memberId?: string | null;
3381
3624
  /**
3382
3625
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3383
3626
  * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
@@ -3386,49 +3629,13 @@ interface ListDemoPostsRequest {
3386
3629
  */
3387
3630
  fieldsets?: PostFieldFieldWithLiterals[];
3388
3631
  }
3389
- declare enum GetPostsSort {
3390
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3391
- FEED = "FEED",
3392
- /** Ordered by `firstPublishedDate` in ascending order. */
3393
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3394
- /** Ordered by `firstPublishedDate` in descending order. */
3395
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3396
- /** Ordered by total number of views in descending order. */
3397
- VIEW_COUNT = "VIEW_COUNT",
3398
- /** Ordered by total number of likes in descending order. */
3399
- LIKE_COUNT = "LIKE_COUNT",
3400
- /** Ordered by `title` in ascending order. */
3401
- TITLE_ASC = "TITLE_ASC",
3402
- /** Ordered by `title` in descending order. */
3403
- TITLE_DESC = "TITLE_DESC"
3404
- }
3405
- /** @enumType */
3406
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3407
- interface BlogPaging {
3408
- /**
3409
- * Number of items to skip in the current sort order.
3410
- *
3411
- *
3412
- * Default: `0`
3413
- */
3414
- offset?: number;
3415
- /**
3416
- * Number of items to return.
3417
- *
3418
- *
3419
- * Default:`50`
3420
- * @min 1
3421
- * @max 100
3422
- */
3423
- limit?: number;
3424
- /**
3425
- * Pointer to the next or previous page in the list of results.
3426
- * @maxLength 2000
3427
- */
3428
- cursor?: string | null;
3429
- }
3430
3632
  declare enum PostFieldField {
3431
3633
  UNKNOWN = "UNKNOWN",
3634
+ /**
3635
+ * Deprecated use `METRICS` instead.
3636
+ * @internal
3637
+ */
3638
+ COUNTERS = "COUNTERS",
3432
3639
  /** Includes post URL when present. */
3433
3640
  URL = "URL",
3434
3641
  /** Includes post content text string when present. */
@@ -3437,103 +3644,72 @@ declare enum PostFieldField {
3437
3644
  METRICS = "METRICS",
3438
3645
  /** Includes SEO data. */
3439
3646
  SEO = "SEO",
3647
+ /**
3648
+ * Includes post content as a stringified DraftJS document.
3649
+ * Reserved for internal use.
3650
+ * @internal
3651
+ */
3652
+ CONTENT = "CONTENT",
3653
+ /**
3654
+ * Includes internal ID field.
3655
+ * Reserved for internal use.
3656
+ * @internal
3657
+ */
3658
+ INTERNAL_ID = "INTERNAL_ID",
3440
3659
  /** Includes post owner's contact ID. */
3441
3660
  CONTACT_ID = "CONTACT_ID",
3442
3661
  /** Includes post rich content. */
3443
3662
  RICH_CONTENT = "RICH_CONTENT",
3444
- /** Includes post reference ID field. */
3445
- REFERENCE_ID = "REFERENCE_ID"
3446
- }
3447
- /** @enumType */
3448
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3449
- interface ListDemoPostsResponse {
3450
- /** List of posts. */
3451
- posts?: Post[];
3452
- /** Details on the paged set of results returned. */
3453
- metaData?: MetaData;
3454
- }
3455
- interface MetaData {
3456
- /** Number of items returned in this response. */
3457
- count?: number;
3458
- /** Requested offset. */
3459
- offset?: number;
3460
- /** Total number of items that match the query. */
3461
- total?: number;
3462
3663
  /**
3463
- * Pointer to the next or previous page in the list of results.
3464
- * @maxLength 2000
3664
+ * Includes post rich content string.
3665
+ * @internal
3465
3666
  */
3466
- cursor?: string | null;
3467
- }
3468
- interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3667
+ RICH_CONTENT_STRING = "RICH_CONTENT_STRING",
3469
3668
  /**
3470
- * Member ID of person who triggered the counter update
3471
- * @format GUID
3669
+ * Includes compressed post rich content string.
3670
+ * @internal
3472
3671
  */
3473
- memberId?: string | null;
3672
+ RICH_CONTENT_COMPRESSED = "RICH_CONTENT_COMPRESSED",
3474
3673
  /**
3475
- * Visitor ID if person that liked the post is not logged in
3476
- * @format GUID
3674
+ * Includes post translations.
3675
+ * @internal
3477
3676
  */
3478
- anonymousVisitorId?: string | null;
3677
+ TRANSLATIONS = "TRANSLATIONS",
3678
+ /** Includes post reference ID field. */
3679
+ REFERENCE_ID = "REFERENCE_ID",
3479
3680
  /**
3480
- * ID of the post which counters were updated.
3481
- * @format GUID
3681
+ * If provided, all content fields exclude paid content.
3682
+ * @internal
3482
3683
  */
3483
- postId?: string;
3484
- /** Field of the updated counter. */
3485
- updatedCounterField?: FieldWithLiterals;
3486
- /** New counter value. */
3487
- counter?: number;
3488
- }
3489
- /** @oneof */
3490
- interface PostCountersUpdatedInitiatorOneOf {
3684
+ EXCLUDE_PAID_CONTENT = "EXCLUDE_PAID_CONTENT",
3491
3685
  /**
3492
- * Member ID of person who triggered the counter update
3493
- * @format GUID
3686
+ * Needed for post proxy to work correctly.
3687
+ * @internal
3494
3688
  */
3495
- memberId?: string | null;
3689
+ SEO_DATA = "SEO_DATA",
3496
3690
  /**
3497
- * Visitor ID if person that liked the post is not logged in
3498
- * @format GUID
3691
+ * Needed for post proxy to work correctly.
3692
+ * @internal
3499
3693
  */
3500
- anonymousVisitorId?: string | null;
3501
- }
3502
- declare enum Field {
3503
- /** Undefined field. */
3504
- UNKNOWN = "UNKNOWN",
3505
- /** Total comments field. */
3506
- TOTAL_COMMENTS = "TOTAL_COMMENTS",
3507
- /** Like count field. */
3508
- LIKE_COUNT = "LIKE_COUNT",
3509
- /** View count field. */
3510
- VIEW_COUNT = "VIEW_COUNT",
3511
- /** Rating count field. */
3512
- RATING_COUNT = "RATING_COUNT"
3513
- }
3514
- /** @enumType */
3515
- type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
3516
- interface PostOwnerChanged {
3517
- }
3518
- interface InitialPostsCopied {
3519
- /** Number of posts copied. */
3520
- count?: number;
3521
- }
3522
- interface GetPostRequest {
3694
+ OWNER = "OWNER",
3523
3695
  /**
3524
- * Post ID.
3525
- * @minLength 1
3526
- * @maxLength 38
3696
+ * Needed for post proxy to work correctly.
3697
+ * @internal
3527
3698
  */
3528
- postId: string;
3699
+ HAS_UNPUBLISHED_CHANGES = "HAS_UNPUBLISHED_CHANGES",
3529
3700
  /**
3530
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3531
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3532
- * only the post’s base fields are returned.
3533
- * @maxSize 20
3701
+ * Needed for post proxy to work correctly.
3702
+ * @internal
3534
3703
  */
3535
- fieldsets?: PostFieldFieldWithLiterals[];
3704
+ HEADING = "HEADING",
3705
+ /**
3706
+ * Needed for post proxy to work correctly.
3707
+ * @internal
3708
+ */
3709
+ IMAGE = "IMAGE"
3536
3710
  }
3711
+ /** @enumType */
3712
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3537
3713
  interface GetPostResponse {
3538
3714
  /** Retrieved post info. */
3539
3715
  post?: Post;
@@ -3545,6 +3721,21 @@ interface GetPostBySlugRequest {
3545
3721
  * @maxLength 200
3546
3722
  */
3547
3723
  slug: string;
3724
+ /**
3725
+ * __Deprecated.__ Use `fieldsets` instead.
3726
+ * This parameter will be removed on June 30, 2023.
3727
+ *
3728
+ * List of post fields to be included in the response.
3729
+ * @internal
3730
+ * @maxSize 20
3731
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3732
+ * This parameter will be removed on June 30, 2023.
3733
+ *
3734
+ * List of post fields to be included in the response.
3735
+ * @replacedBy fieldsets
3736
+ * @targetRemovalDate 2024-06-30
3737
+ */
3738
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3548
3739
  /**
3549
3740
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3550
3741
  * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
@@ -3604,6 +3795,21 @@ interface ListPostsRequest {
3604
3795
  sort?: GetPostsSortWithLiterals;
3605
3796
  /** Pagination options. */
3606
3797
  paging?: BlogPaging;
3798
+ /**
3799
+ * __Deprecated.__ Use `fieldsets` instead.
3800
+ * This parameter will be removed on June 30, 2023.
3801
+ *
3802
+ * List of post fields to be included in the response.
3803
+ * @internal
3804
+ * @maxSize 20
3805
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3806
+ * This parameter will be removed on June 30, 2023.
3807
+ *
3808
+ * List of post fields to be included in the response.
3809
+ * @replacedBy fieldsets
3810
+ * @targetRemovalDate 2024-06-30
3811
+ */
3812
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3607
3813
  /**
3608
3814
  * Language filter.
3609
3815
  *
@@ -3626,13 +3832,130 @@ interface ListPostsRequest {
3626
3832
  */
3627
3833
  fieldsets?: PostFieldFieldWithLiterals[];
3628
3834
  }
3835
+ declare enum GetPostsSort {
3836
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3837
+ FEED = "FEED",
3838
+ /** Ordered by `firstPublishedDate` in ascending order. */
3839
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3840
+ /** Ordered by `firstPublishedDate` in descending order. */
3841
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3842
+ /** Ordered by total number of views in descending order. */
3843
+ VIEW_COUNT = "VIEW_COUNT",
3844
+ /** Ordered by total number of likes in descending order. */
3845
+ LIKE_COUNT = "LIKE_COUNT",
3846
+ /** Ordered by `title` in ascending order. */
3847
+ TITLE_ASC = "TITLE_ASC",
3848
+ /** Ordered by `title` in descending order. */
3849
+ TITLE_DESC = "TITLE_DESC",
3850
+ /**
3851
+ * Sorting by post rating descending.
3852
+ * @internal
3853
+ */
3854
+ RATING = "RATING"
3855
+ }
3856
+ /** @enumType */
3857
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3858
+ interface BlogPaging {
3859
+ /**
3860
+ * Number of items to skip in the current sort order.
3861
+ *
3862
+ *
3863
+ * Default: `0`
3864
+ */
3865
+ offset?: number;
3866
+ /**
3867
+ * Number of items to return.
3868
+ *
3869
+ *
3870
+ * Default:`50`
3871
+ * @min 1
3872
+ * @max 100
3873
+ */
3874
+ limit?: number;
3875
+ /**
3876
+ * Pointer to the next or previous page in the list of results.
3877
+ * @maxLength 2000
3878
+ */
3879
+ cursor?: string | null;
3880
+ }
3629
3881
  interface ListPostsResponse {
3630
3882
  /** List of retrieved posts. */
3631
3883
  posts?: Post[];
3632
3884
  /** Details on the paged set of results returned. */
3633
3885
  metaData?: MetaData;
3634
3886
  }
3887
+ interface MetaData {
3888
+ /** Number of items returned in this response. */
3889
+ count?: number;
3890
+ /** Requested offset. */
3891
+ offset?: number;
3892
+ /** Total number of items that match the query. */
3893
+ total?: number;
3894
+ /**
3895
+ * Pointer to the next or previous page in the list of results.
3896
+ * @maxLength 2000
3897
+ */
3898
+ cursor?: string | null;
3899
+ }
3635
3900
  interface QueryPostsRequest {
3901
+ /**
3902
+ * __Deprecated.__ Use `query` instead.
3903
+ * This parameter will be removed on June 30, 2023.
3904
+ *
3905
+ * Pagination options.
3906
+ * @internal
3907
+ * @deprecated __Deprecated.__ Use `query` instead.
3908
+ * This parameter will be removed on June 30, 2023.
3909
+ *
3910
+ * Pagination options.
3911
+ * @replacedBy query
3912
+ * @targetRemovalDate 2024-06-30
3913
+ */
3914
+ paging?: BlogPaging;
3915
+ /**
3916
+ * __Deprecated.__ Use `query` instead.
3917
+ * This parameter will be removed on June 30, 2023.
3918
+ *
3919
+ * Filter object.
3920
+ * @internal
3921
+ * @deprecated __Deprecated.__ Use `query` instead.
3922
+ * This parameter will be removed on June 30, 2023.
3923
+ *
3924
+ * Filter object.
3925
+ * @replacedBy query
3926
+ * @targetRemovalDate 2024-06-30
3927
+ */
3928
+ filter?: Record<string, any> | null;
3929
+ /**
3930
+ * __Deprecated.__ Use `query` instead.
3931
+ * This parameter will be removed on June 30, 2023.
3932
+ *
3933
+ * Sorting options.
3934
+ * @internal
3935
+ * @maxSize 3
3936
+ * @deprecated __Deprecated.__ Use `query` instead.
3937
+ * This parameter will be removed on June 30, 2023.
3938
+ *
3939
+ * Sorting options.
3940
+ * @replacedBy query
3941
+ * @targetRemovalDate 2024-06-30
3942
+ */
3943
+ sort?: Sorting[];
3944
+ /**
3945
+ * __Deprecated.__ Use `fieldsets` instead.
3946
+ * This parameter will be removed on June 30, 2023.
3947
+ *
3948
+ * List of post fields to be included in the response.
3949
+ * @internal
3950
+ * @maxSize 20
3951
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3952
+ * This parameter will be removed on June 30, 2023.
3953
+ *
3954
+ * List of post fields to be included in the response.
3955
+ * @replacedBy fieldsets
3956
+ * @targetRemovalDate 2024-06-30
3957
+ */
3958
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3636
3959
  /** Query options. */
3637
3960
  query?: PlatformQuery;
3638
3961
  /**
@@ -3651,6 +3974,20 @@ interface Sorting {
3651
3974
  fieldName?: string;
3652
3975
  /** Sort order. */
3653
3976
  order?: SortOrderWithLiterals;
3977
+ /**
3978
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
3979
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
3980
+ *
3981
+ * If multiple filters are provided, they are combined with AND operator.
3982
+ *
3983
+ * Example:
3984
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
3985
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
3986
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
3987
+ * @internal
3988
+ * @maxSize 10
3989
+ */
3990
+ selectItemsBy?: Record<string, any>[] | null;
3654
3991
  /**
3655
3992
  * Origin point for geo-distance sorting on a GEO field
3656
3993
  * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -3725,6 +4062,20 @@ interface CursorPaging {
3725
4062
  interface QueryPostsResponse {
3726
4063
  /** List of retrieved posts. */
3727
4064
  posts?: Post[];
4065
+ /**
4066
+ * __Deprecated.__ Use `pagingMetadata` instead.
4067
+ * This property will be removed on June 30, 2023.
4068
+ *
4069
+ * Details on the paged set of results returned.
4070
+ * @internal
4071
+ * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
4072
+ * This property will be removed on June 30, 2023.
4073
+ *
4074
+ * Details on the paged set of results returned.
4075
+ * @replacedBy pagingMetadata
4076
+ * @targetRemovalDate 2024-06-30
4077
+ */
4078
+ metaData?: MetaData;
3728
4079
  /** Details on the paged set of results returned. */
3729
4080
  pagingMetadata?: PagingMetadataV2;
3730
4081
  }
@@ -3739,6 +4090,13 @@ interface PagingMetadataV2 {
3739
4090
  tooManyToCount?: boolean | null;
3740
4091
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
3741
4092
  cursors?: Cursors;
4093
+ /**
4094
+ * Indicates if there are more results after the current page.
4095
+ * If `true`, another page of results can be retrieved.
4096
+ * If `false`, this is the last page.
4097
+ * @internal
4098
+ */
4099
+ hasNext?: boolean | null;
3742
4100
  }
3743
4101
  interface Cursors {
3744
4102
  /**
@@ -3986,6 +4344,99 @@ interface PostCount {
3986
4344
  /** Number of posts. */
3987
4345
  postCount?: number;
3988
4346
  }
4347
+ interface ListDemoPostsRequest {
4348
+ /**
4349
+ * Whether to return only featured posts.
4350
+ *
4351
+ * Default: `false`
4352
+ */
4353
+ featured?: boolean;
4354
+ /**
4355
+ * Hashtag filter.
4356
+ *
4357
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4358
+ * If omitted, all posts with or without hashtags are returned.
4359
+ * @maxSize 100
4360
+ * @maxLength 100
4361
+ */
4362
+ hashtags?: string[];
4363
+ /**
4364
+ * Category filter.
4365
+ *
4366
+ * Pass an array of category IDs to return only posts with any of the provided categories.
4367
+ * If omitted, all posts with or without associated categories are returned.
4368
+ * @maxSize 50
4369
+ * @format GUID
4370
+ */
4371
+ categoryIds?: string[];
4372
+ /**
4373
+ * Tag filter.
4374
+ *
4375
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
4376
+ * If omitted, all posts with or without tags are returned.
4377
+ * @maxSize 50
4378
+ * @format GUID
4379
+ */
4380
+ tagIds?: string[];
4381
+ /**
4382
+ * Sorting options.
4383
+ *
4384
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4385
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4386
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4387
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4388
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4389
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
4390
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
4391
+ * - `RATING`: reserved for internal use.
4392
+ *
4393
+ * Default: `FEED`
4394
+ */
4395
+ sort?: GetPostsSortWithLiterals;
4396
+ /** Pagination options. */
4397
+ paging?: BlogPaging;
4398
+ /**
4399
+ * __Deprecated.__ Use `fieldsets` instead.
4400
+ * This parameter will be removed on June 30, 2023.
4401
+ *
4402
+ * List of post fields to be included in the response.
4403
+ * @maxSize 20
4404
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
4405
+ * This parameter will be removed on June 30, 2023.
4406
+ *
4407
+ * List of post fields to be included in the response.
4408
+ * @replacedBy fieldsets
4409
+ * @targetRemovalDate 2024-06-30
4410
+ */
4411
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
4412
+ /**
4413
+ * Language filter.
4414
+ *
4415
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4416
+ * Pass a language to only receive posts that are in that language.
4417
+ * If omitted, posts in all languages are returned.
4418
+ * @format LANGUAGE_TAG
4419
+ */
4420
+ language?: string | null;
4421
+ /**
4422
+ * Post owner's member ID.
4423
+ * @format GUID
4424
+ */
4425
+ memberId?: string | null;
4426
+ /**
4427
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4428
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4429
+ * only the post’s base fields are returned.
4430
+ * @maxSize 20
4431
+ */
4432
+ fieldsets?: PostFieldFieldWithLiterals[];
4433
+ }
4434
+ interface ListDemoPostsResponse {
4435
+ /** List of posts. */
4436
+ posts?: Post[];
4437
+ /** Details on the paged set of results returned. */
4438
+ metaData?: MetaData;
4439
+ }
3989
4440
  interface BaseEventMetadata {
3990
4441
  /**
3991
4442
  * App instance ID.
@@ -4352,6 +4803,64 @@ interface ListPostsOptions {
4352
4803
  */
4353
4804
  declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
4354
4805
  interface QueryPostsOptions {
4806
+ /**
4807
+ * __Deprecated.__ Use `query` instead.
4808
+ * This parameter will be removed on June 30, 2023.
4809
+ *
4810
+ * Pagination options.
4811
+ * @internal
4812
+ * @deprecated __Deprecated.__ Use `query` instead.
4813
+ * This parameter will be removed on June 30, 2023.
4814
+ *
4815
+ * Pagination options.
4816
+ * @replacedBy query
4817
+ * @targetRemovalDate 2024-06-30
4818
+ */
4819
+ paging?: BlogPaging | undefined;
4820
+ /**
4821
+ * __Deprecated.__ Use `query` instead.
4822
+ * This parameter will be removed on June 30, 2023.
4823
+ *
4824
+ * Filter object.
4825
+ * @internal
4826
+ * @deprecated __Deprecated.__ Use `query` instead.
4827
+ * This parameter will be removed on June 30, 2023.
4828
+ *
4829
+ * Filter object.
4830
+ * @replacedBy query
4831
+ * @targetRemovalDate 2024-06-30
4832
+ */
4833
+ filter?: Record<string, any> | null | undefined;
4834
+ /**
4835
+ * __Deprecated.__ Use `query` instead.
4836
+ * This parameter will be removed on June 30, 2023.
4837
+ *
4838
+ * Sorting options.
4839
+ * @internal
4840
+ * @maxSize 3
4841
+ * @deprecated __Deprecated.__ Use `query` instead.
4842
+ * This parameter will be removed on June 30, 2023.
4843
+ *
4844
+ * Sorting options.
4845
+ * @replacedBy query
4846
+ * @targetRemovalDate 2024-06-30
4847
+ */
4848
+ sort?: Sorting[] | undefined;
4849
+ /**
4850
+ * __Deprecated.__ Use `fieldsets` instead.
4851
+ * This parameter will be removed on June 30, 2023.
4852
+ *
4853
+ * List of post fields to be included in the response.
4854
+ * @internal
4855
+ * @maxSize 20
4856
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
4857
+ * This parameter will be removed on June 30, 2023.
4858
+ *
4859
+ * List of post fields to be included in the response.
4860
+ * @replacedBy fieldsets
4861
+ * @targetRemovalDate 2024-06-30
4862
+ */
4863
+ fieldsToInclude?: PostFieldFieldWithLiterals[] | undefined;
4355
4864
  /**
4356
4865
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4357
4866
  * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
@@ -4590,6 +5099,20 @@ type PostQuery = {
4590
5099
  */
4591
5100
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
4592
5101
  /**
5102
+ When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
5103
+ a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
5104
+
5105
+ If multiple filters are provided, they are combined with AND operator.
5106
+
5107
+ Example:
5108
+ Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
5109
+ and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
5110
+ { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
5111
+ @internal: undefined,
5112
+ @maxSize: 10
5113
+ */
5114
+ selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
5115
+ /**
4593
5116
  Origin point for geo-distance sorting on a GEO field
4594
5117
  results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
4595
5118
  */
@@ -4616,4 +5139,4 @@ declare const utils: {
4616
5139
  */
4617
5140
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4618
5141
 
4619
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
5142
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostsSort, type GetPostsSortWithLiterals, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListItemNodeData, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };