@wix/auto_sdk_blog_posts 1.0.170 → 1.0.172

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 (49) hide show
  1. package/build/cjs/index.d.ts +11 -15
  2. package/build/cjs/index.js +30 -35
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +199 -196
  5. package/build/cjs/index.typings.js +25 -25
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +182 -167
  8. package/build/cjs/meta.js +19 -19
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +84 -86
  11. package/build/cjs/schemas.js +150 -156
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +11 -15
  14. package/build/es/index.mjs +30 -35
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +199 -196
  17. package/build/es/index.typings.mjs +25 -25
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +182 -167
  20. package/build/es/meta.mjs +19 -19
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +84 -86
  23. package/build/es/schemas.mjs +150 -156
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +11 -15
  26. package/build/internal/cjs/index.js +30 -35
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +253 -250
  29. package/build/internal/cjs/index.typings.js +25 -25
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +236 -221
  32. package/build/internal/cjs/meta.js +19 -19
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +84 -86
  35. package/build/internal/cjs/schemas.js +150 -156
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +11 -15
  38. package/build/internal/es/index.mjs +30 -35
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +253 -250
  41. package/build/internal/es/index.typings.mjs +25 -25
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +236 -221
  44. package/build/internal/es/meta.mjs +19 -19
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +84 -86
  47. package/build/internal/es/schemas.mjs +150 -156
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -230,7 +230,22 @@ interface Tag {
230
230
  meta?: Record<string, any> | null;
231
231
  /** SEO tag inner content. For example, `<title> inner content </title>`. */
232
232
  children?: string;
233
- /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
233
+ /**
234
+ * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
235
+ * i.e. an entry from the site's Advanced/Custom Tags list.
236
+ *
237
+ * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
238
+ * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
239
+ * default/pattern — standard tags always resolve with `custom: false`, even when their content comes
240
+ * from a page's manually saved SEO title/description override. Don't use this field to verify whether
241
+ * a live page reflects a manual per-page SEO edit.
242
+ *
243
+ * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
244
+ * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
245
+ * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
246
+ * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
247
+ * Pass `seoData` explicitly to resolve against a known set of tags.
248
+ */
234
249
  custom?: boolean;
235
250
  /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
236
251
  disabled?: boolean;
@@ -3401,6 +3416,172 @@ interface GetTotalPostsResponse {
3401
3416
  /** Total amount of published posts. */
3402
3417
  total?: number;
3403
3418
  }
3419
+ interface ListDemoPostsRequest {
3420
+ /**
3421
+ * Whether to return only featured posts.
3422
+ *
3423
+ * Default: `false`
3424
+ */
3425
+ featured?: boolean;
3426
+ /**
3427
+ * Hashtag filter.
3428
+ *
3429
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3430
+ * If omitted, all posts with or without hashtags are returned.
3431
+ * @maxSize 100
3432
+ * @maxLength 100
3433
+ */
3434
+ hashtags?: string[];
3435
+ /**
3436
+ * Category filter.
3437
+ *
3438
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3439
+ * If omitted, all posts with or without associated categories are returned.
3440
+ * @maxSize 50
3441
+ * @format GUID
3442
+ */
3443
+ categoryIds?: string[];
3444
+ /**
3445
+ * Tag filter.
3446
+ *
3447
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3448
+ * If omitted, all posts with or without tags are returned.
3449
+ * @maxSize 50
3450
+ * @format GUID
3451
+ */
3452
+ tagIds?: string[];
3453
+ /**
3454
+ * Sorting options.
3455
+ *
3456
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3457
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3458
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3459
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3460
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3461
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3462
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3463
+ * - `RATING`: reserved for internal use.
3464
+ *
3465
+ * Default: `FEED`
3466
+ */
3467
+ sort?: GetPostsSortWithLiterals;
3468
+ /** Pagination options. */
3469
+ paging?: BlogPaging;
3470
+ /**
3471
+ * __Deprecated.__ Use `fieldsets` instead.
3472
+ * This parameter will be removed on June 30, 2023.
3473
+ *
3474
+ * List of post fields to be included in the response.
3475
+ * @maxSize 20
3476
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3477
+ * This parameter will be removed on June 30, 2023.
3478
+ *
3479
+ * List of post fields to be included in the response.
3480
+ * @replacedBy fieldsets
3481
+ * @targetRemovalDate 2024-06-30
3482
+ */
3483
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3484
+ /**
3485
+ * Language filter.
3486
+ *
3487
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3488
+ * Pass a language to only receive posts that are in that language.
3489
+ * If omitted, posts in all languages are returned.
3490
+ * @format LANGUAGE_TAG
3491
+ */
3492
+ language?: string | null;
3493
+ /**
3494
+ * Post owner's member ID.
3495
+ * @format GUID
3496
+ */
3497
+ memberId?: string | null;
3498
+ /**
3499
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3500
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3501
+ * only the post’s base fields are returned.
3502
+ * @maxSize 20
3503
+ */
3504
+ fieldsets?: PostFieldFieldWithLiterals[];
3505
+ }
3506
+ declare enum GetPostsSort {
3507
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3508
+ FEED = "FEED",
3509
+ /** Ordered by `firstPublishedDate` in ascending order. */
3510
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3511
+ /** Ordered by `firstPublishedDate` in descending order. */
3512
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3513
+ /** Ordered by total number of views in descending order. */
3514
+ VIEW_COUNT = "VIEW_COUNT",
3515
+ /** Ordered by total number of likes in descending order. */
3516
+ LIKE_COUNT = "LIKE_COUNT",
3517
+ /** Ordered by `title` in ascending order. */
3518
+ TITLE_ASC = "TITLE_ASC",
3519
+ /** Ordered by `title` in descending order. */
3520
+ TITLE_DESC = "TITLE_DESC"
3521
+ }
3522
+ /** @enumType */
3523
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3524
+ interface BlogPaging {
3525
+ /**
3526
+ * Number of items to skip in the current sort order.
3527
+ *
3528
+ *
3529
+ * Default: `0`
3530
+ */
3531
+ offset?: number;
3532
+ /**
3533
+ * Number of items to return.
3534
+ *
3535
+ *
3536
+ * Default:`50`
3537
+ * @min 1
3538
+ * @max 100
3539
+ */
3540
+ limit?: number;
3541
+ /**
3542
+ * Pointer to the next or previous page in the list of results.
3543
+ * @maxLength 2000
3544
+ */
3545
+ cursor?: string | null;
3546
+ }
3547
+ declare enum PostFieldField {
3548
+ UNKNOWN = "UNKNOWN",
3549
+ /** Includes post URL when present. */
3550
+ URL = "URL",
3551
+ /** Includes post content text string when present. */
3552
+ CONTENT_TEXT = "CONTENT_TEXT",
3553
+ /** Includes post metrics when present. */
3554
+ METRICS = "METRICS",
3555
+ /** Includes SEO data. */
3556
+ SEO = "SEO",
3557
+ /** Includes post owner's contact ID. */
3558
+ CONTACT_ID = "CONTACT_ID",
3559
+ /** Includes post rich content. */
3560
+ RICH_CONTENT = "RICH_CONTENT",
3561
+ /** Includes post reference ID field. */
3562
+ REFERENCE_ID = "REFERENCE_ID"
3563
+ }
3564
+ /** @enumType */
3565
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3566
+ interface ListDemoPostsResponse {
3567
+ /** List of posts. */
3568
+ posts?: Post[];
3569
+ /** Details on the paged set of results returned. */
3570
+ metaData?: MetaData;
3571
+ }
3572
+ interface MetaData {
3573
+ /** Number of items returned in this response. */
3574
+ count?: number;
3575
+ /** Requested offset. */
3576
+ offset?: number;
3577
+ /** Total number of items that match the query. */
3578
+ total?: number;
3579
+ /**
3580
+ * Pointer to the next or previous page in the list of results.
3581
+ * @maxLength 2000
3582
+ */
3583
+ cursor?: string | null;
3584
+ }
3404
3585
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3405
3586
  /**
3406
3587
  * Member ID of person who triggered the counter update
@@ -3470,25 +3651,6 @@ interface GetPostRequest {
3470
3651
  */
3471
3652
  fieldsets?: PostFieldFieldWithLiterals[];
3472
3653
  }
3473
- declare enum PostFieldField {
3474
- UNKNOWN = "UNKNOWN",
3475
- /** Includes post URL when present. */
3476
- URL = "URL",
3477
- /** Includes post content text string when present. */
3478
- CONTENT_TEXT = "CONTENT_TEXT",
3479
- /** Includes post metrics when present. */
3480
- METRICS = "METRICS",
3481
- /** Includes SEO data. */
3482
- SEO = "SEO",
3483
- /** Includes post owner's contact ID. */
3484
- CONTACT_ID = "CONTACT_ID",
3485
- /** Includes post rich content. */
3486
- RICH_CONTENT = "RICH_CONTENT",
3487
- /** Includes post reference ID field. */
3488
- REFERENCE_ID = "REFERENCE_ID"
3489
- }
3490
- /** @enumType */
3491
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3492
3654
  interface GetPostResponse {
3493
3655
  /** Retrieved post info. */
3494
3656
  post?: Post;
@@ -3581,66 +3743,12 @@ interface ListPostsRequest {
3581
3743
  */
3582
3744
  fieldsets?: PostFieldFieldWithLiterals[];
3583
3745
  }
3584
- declare enum GetPostsSort {
3585
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3586
- FEED = "FEED",
3587
- /** Ordered by `firstPublishedDate` in ascending order. */
3588
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3589
- /** Ordered by `firstPublishedDate` in descending order. */
3590
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3591
- /** Ordered by total number of views in descending order. */
3592
- VIEW_COUNT = "VIEW_COUNT",
3593
- /** Ordered by total number of likes in descending order. */
3594
- LIKE_COUNT = "LIKE_COUNT",
3595
- /** Ordered by `title` in ascending order. */
3596
- TITLE_ASC = "TITLE_ASC",
3597
- /** Ordered by `title` in descending order. */
3598
- TITLE_DESC = "TITLE_DESC"
3599
- }
3600
- /** @enumType */
3601
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3602
- interface BlogPaging {
3603
- /**
3604
- * Number of items to skip in the current sort order.
3605
- *
3606
- *
3607
- * Default: `0`
3608
- */
3609
- offset?: number;
3610
- /**
3611
- * Number of items to return.
3612
- *
3613
- *
3614
- * Default:`50`
3615
- * @min 1
3616
- * @max 100
3617
- */
3618
- limit?: number;
3619
- /**
3620
- * Pointer to the next or previous page in the list of results.
3621
- * @maxLength 2000
3622
- */
3623
- cursor?: string | null;
3624
- }
3625
3746
  interface ListPostsResponse {
3626
3747
  /** List of retrieved posts. */
3627
3748
  posts?: Post[];
3628
3749
  /** Details on the paged set of results returned. */
3629
3750
  metaData?: MetaData;
3630
3751
  }
3631
- interface MetaData {
3632
- /** Number of items returned in this response. */
3633
- count?: number;
3634
- /** Requested offset. */
3635
- offset?: number;
3636
- /** Total number of items that match the query. */
3637
- total?: number;
3638
- /**
3639
- * Pointer to the next or previous page in the list of results.
3640
- * @maxLength 2000
3641
- */
3642
- cursor?: string | null;
3643
- }
3644
3752
  interface QueryPostsRequest {
3645
3753
  /** Query options. */
3646
3754
  query?: PlatformQuery;
@@ -3995,99 +4103,6 @@ interface PostCount {
3995
4103
  /** Number of posts. */
3996
4104
  postCount?: number;
3997
4105
  }
3998
- interface ListDemoPostsRequest {
3999
- /**
4000
- * Whether to return only featured posts.
4001
- *
4002
- * Default: `false`
4003
- */
4004
- featured?: boolean;
4005
- /**
4006
- * Hashtag filter.
4007
- *
4008
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4009
- * If omitted, all posts with or without hashtags are returned.
4010
- * @maxSize 100
4011
- * @maxLength 100
4012
- */
4013
- hashtags?: string[];
4014
- /**
4015
- * Category filter.
4016
- *
4017
- * Pass an array of category IDs to return only posts with any of the provided categories.
4018
- * If omitted, all posts with or without associated categories are returned.
4019
- * @maxSize 50
4020
- * @format GUID
4021
- */
4022
- categoryIds?: string[];
4023
- /**
4024
- * Tag filter.
4025
- *
4026
- * Pass an array of tag IDs to return only posts with any of the provided tags.
4027
- * If omitted, all posts with or without tags are returned.
4028
- * @maxSize 50
4029
- * @format GUID
4030
- */
4031
- tagIds?: string[];
4032
- /**
4033
- * Sorting options.
4034
- *
4035
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4036
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4037
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4038
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4039
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4040
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
4041
- * - `TITLE_DESC`: Ordered by `title` in descending order.
4042
- * - `RATING`: reserved for internal use.
4043
- *
4044
- * Default: `FEED`
4045
- */
4046
- sort?: GetPostsSortWithLiterals;
4047
- /** Pagination options. */
4048
- paging?: BlogPaging;
4049
- /**
4050
- * __Deprecated.__ Use `fieldsets` instead.
4051
- * This parameter will be removed on June 30, 2023.
4052
- *
4053
- * List of post fields to be included in the response.
4054
- * @maxSize 20
4055
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4056
- * This parameter will be removed on June 30, 2023.
4057
- *
4058
- * List of post fields to be included in the response.
4059
- * @replacedBy fieldsets
4060
- * @targetRemovalDate 2024-06-30
4061
- */
4062
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4063
- /**
4064
- * Language filter.
4065
- *
4066
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4067
- * Pass a language to only receive posts that are in that language.
4068
- * If omitted, posts in all languages are returned.
4069
- * @format LANGUAGE_TAG
4070
- */
4071
- language?: string | null;
4072
- /**
4073
- * Post owner's member ID.
4074
- * @format GUID
4075
- */
4076
- memberId?: string | null;
4077
- /**
4078
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4079
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4080
- * only the post’s base fields are returned.
4081
- * @maxSize 20
4082
- */
4083
- fieldsets?: PostFieldFieldWithLiterals[];
4084
- }
4085
- interface ListDemoPostsResponse {
4086
- /** List of posts. */
4087
- posts?: Post[];
4088
- /** Details on the paged set of results returned. */
4089
- metaData?: MetaData;
4090
- }
4091
4106
  interface BaseEventMetadata {
4092
4107
  /**
4093
4108
  * App instance ID.
@@ -4235,14 +4250,13 @@ declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | P
4235
4250
  /**
4236
4251
  * Retrieves the number of published posts per month within a specified time range.
4237
4252
  *
4238
- *
4239
- * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
4240
- *
4241
- * You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
4242
- *
4243
- * >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
4253
+ * The time range is set using the `rangeStart` and `months` properties.
4254
+ * The time range always starts on the 1st day of the month set in `rangeStart` and
4255
+ * includes the number of `months` following `rangeStart`.
4256
+ * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
4257
+ * the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
4258
+ * > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
4244
4259
  * @public
4245
- * @param options - Options specifying time frame, sort, and filter.
4246
4260
  * @permissionId BLOG.READ-PUBLICATION
4247
4261
  * @applicableIdentity APP
4248
4262
  * @returns Get Blog Post Count Stats response
@@ -4283,7 +4297,6 @@ interface QueryPostCountStatsOptions {
4283
4297
  /**
4284
4298
  * Retrieves the total amount of published posts of the blog.
4285
4299
  * @public
4286
- * @param options - Language Options.
4287
4300
  * @permissionId BLOG.READ-PUBLICATION
4288
4301
  * @applicableIdentity APP
4289
4302
  * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
@@ -4304,12 +4317,12 @@ interface GetTotalPostsOptions {
4304
4317
  * @param postId - Post ID.
4305
4318
  * @public
4306
4319
  * @requiredField postId
4307
- * @param options - Options specifying which fields to return.
4308
4320
  * @permissionId BLOG.READ-PUBLICATION
4309
4321
  * @applicableIdentity APP
4322
+ * @returns Retrieved post info.
4310
4323
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
4311
4324
  */
4312
- declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, `post._id` | `post.title` | `post.excerpt` | `post.slug` | `post.featured` | `post.pinned` | `post.categoryIds` | `post.memberId` | `post.hashtags` | `post.commentingEnabled` | `post.minutesToRead` | `post.tagIds` | `post.relatedPostIds` | `post.pricingPlanIds` | `post.seoData.tags` | `post.seoData.tags.${number}.type` | `post.seoData.tags.${number}.children` | `post.seoData.tags.${number}.custom` | `post.seoData.tags.${number}.disabled` | `post.seoData.settings.preventAutoRedirect` | `post.seoData.settings.keywords` | `post.seoData.settings.keywords.${number}.term` | `post.seoData.settings.keywords.${number}.isMain` | `post.preview` | `post.moderationDetails.submittedBy` | `post.moderationDetails.status` | `post.media.embedMedia.thumbnail.url` | `post.media.embedMedia.thumbnail.width` | `post.media.embedMedia.thumbnail.height` | `post.media.embedMedia.video.url` | `post.media.embedMedia.video.width` | `post.media.embedMedia.video.height` | `post.media.displayed` | `post.media.custom` | `post.hasUnpublishedChanges`, 7>>;
4325
+ declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`, 6>>;
4313
4326
  interface GetPostOptions {
4314
4327
  /**
4315
4328
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -4329,7 +4342,6 @@ interface GetPostOptions {
4329
4342
  * @param slug - Slug of the post to retrieve.
4330
4343
  * @public
4331
4344
  * @requiredField slug
4332
- * @param options - Options specifying which fields to return.
4333
4345
  * @permissionId BLOG.READ-PUBLICATION
4334
4346
  * @applicableIdentity APP
4335
4347
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
@@ -4357,7 +4369,6 @@ interface GetPostBySlugOptions {
4357
4369
  * - `paging.limit` is `50`.
4358
4370
  * - `paging.offset` is `0`.
4359
4371
  * @public
4360
- * @param options - Sort, filter, and paging options.
4361
4372
  * @permissionId BLOG.READ-PUBLICATION
4362
4373
  * @applicableIdentity APP
4363
4374
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
@@ -4428,26 +4439,18 @@ interface ListPostsOptions {
4428
4439
  fieldsets?: PostFieldFieldWithLiterals[];
4429
4440
  }
4430
4441
  /**
4431
- * Creates a query to retrieve a list of posts.
4432
- *
4433
- *
4434
- * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
4435
- *
4436
- * The returned object contains the query definition which is typically used to run the query using the `find()` function.
4437
- *
4438
- * You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
4442
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
4439
4443
  *
4440
- * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
4441
- * + `limit(50)`
4442
- * + `descending('firstPublishedDate')`
4443
- *
4444
- * Note that the default limit is `'50'`, but the max limit is `'100'`.
4445
- *
4446
- * To learn how to query posts, refer to the table below.
4444
+ * Query Posts runs with these defaults, which you can override:
4445
+ * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
4446
+ * - `paging.limit` is `50`.
4447
+ * - `paging.offset` is `0`.
4447
4448
  *
4448
- * The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
4449
+ * To learn about working with _Query_ endpoints, see
4450
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
4451
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
4452
+ * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
4449
4453
  * @public
4450
- * @param options - Options specifying which fields to return.
4451
4454
  * @permissionId BLOG.READ-PUBLICATION
4452
4455
  * @applicableIdentity APP
4453
4456
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
@@ -1693,14 +1693,17 @@ var Order = /* @__PURE__ */ ((Order2) => {
1693
1693
  Order2["NEWEST"] = "NEWEST";
1694
1694
  return Order2;
1695
1695
  })(Order || {});
1696
- var Field = /* @__PURE__ */ ((Field2) => {
1697
- Field2["UNKNOWN"] = "UNKNOWN";
1698
- Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1699
- Field2["LIKE_COUNT"] = "LIKE_COUNT";
1700
- Field2["VIEW_COUNT"] = "VIEW_COUNT";
1701
- Field2["RATING_COUNT"] = "RATING_COUNT";
1702
- return Field2;
1703
- })(Field || {});
1696
+ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1697
+ GetPostsSort2["FEED"] = "FEED";
1698
+ GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1699
+ GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1700
+ GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1701
+ GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1702
+ GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1703
+ GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1704
+ GetPostsSort2["RATING"] = "RATING";
1705
+ return GetPostsSort2;
1706
+ })(GetPostsSort || {});
1704
1707
  var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1705
1708
  PostFieldField2["UNKNOWN"] = "UNKNOWN";
1706
1709
  PostFieldField2["COUNTERS"] = "COUNTERS";
@@ -1724,17 +1727,14 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1724
1727
  PostFieldField2["IMAGE"] = "IMAGE";
1725
1728
  return PostFieldField2;
1726
1729
  })(PostFieldField || {});
1727
- var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1728
- GetPostsSort2["FEED"] = "FEED";
1729
- GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1730
- GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1731
- GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1732
- GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1733
- GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1734
- GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1735
- GetPostsSort2["RATING"] = "RATING";
1736
- return GetPostsSort2;
1737
- })(GetPostsSort || {});
1730
+ var Field = /* @__PURE__ */ ((Field2) => {
1731
+ Field2["UNKNOWN"] = "UNKNOWN";
1732
+ Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1733
+ Field2["LIKE_COUNT"] = "LIKE_COUNT";
1734
+ Field2["VIEW_COUNT"] = "VIEW_COUNT";
1735
+ Field2["RATING_COUNT"] = "RATING_COUNT";
1736
+ return Field2;
1737
+ })(Field || {});
1738
1738
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
1739
1739
  SortOrder2["ASC"] = "ASC";
1740
1740
  SortOrder2["DESC"] = "DESC";
@@ -1833,8 +1833,8 @@ async function getPost2(postId, options) {
1833
1833
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1834
1834
  }
1835
1835
  ]),
1836
- ["post.richContent", "post.rich_content"]
1837
- );
1836
+ ["post.richContent"]
1837
+ )?.post;
1838
1838
  } catch (err) {
1839
1839
  const transformedError = (0, import_transform_error.transformError)(
1840
1840
  err,
@@ -1881,7 +1881,7 @@ async function getPostBySlug2(slug, options) {
1881
1881
  paths: [{ path: "post.media.wixMedia.videoV2" }]
1882
1882
  }
1883
1883
  ]),
1884
- ["post.richContent", "post.rich_content"]
1884
+ ["post.richContent"]
1885
1885
  );
1886
1886
  } catch (err) {
1887
1887
  const transformedError = (0, import_transform_error.transformError)(
@@ -1940,7 +1940,7 @@ async function listPosts2(options) {
1940
1940
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
1941
1941
  }
1942
1942
  ]),
1943
- ["posts.richContent", "posts.rich_content"]
1943
+ ["posts.richContent"]
1944
1944
  );
1945
1945
  } catch (err) {
1946
1946
  const transformedError = (0, import_transform_error.transformError)(
@@ -2010,7 +2010,7 @@ function queryPosts2(options) {
2010
2010
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
2011
2011
  }
2012
2012
  ]),
2013
- ["posts.richContent", "posts.rich_content"]
2013
+ ["posts.richContent"]
2014
2014
  );
2015
2015
  return {
2016
2016
  items: transformedData?.posts,
@@ -2058,7 +2058,7 @@ async function typedQueryPosts(query, options) {
2058
2058
  paths: [{ path: "posts.media.wixMedia.videoV2" }]
2059
2059
  }
2060
2060
  ]),
2061
- ["posts.richContent", "posts.rich_content"]
2061
+ ["posts.richContent"]
2062
2062
  );
2063
2063
  } catch (err) {
2064
2064
  const transformedError = (0, import_transform_error.transformError)(