@wix/auto_sdk_blog_posts 1.0.170 → 1.0.171

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 +19 -19
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +175 -167
  4. package/build/cjs/index.typings.js +19 -19
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +175 -167
  7. package/build/cjs/meta.js +19 -19
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.d.ts +2 -2
  10. package/build/cjs/schemas.js +4 -4
  11. package/build/cjs/schemas.js.map +1 -1
  12. package/build/es/index.mjs +19 -19
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +175 -167
  15. package/build/es/index.typings.mjs +19 -19
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +175 -167
  18. package/build/es/meta.mjs +19 -19
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/schemas.d.mts +2 -2
  21. package/build/es/schemas.mjs +4 -4
  22. package/build/es/schemas.mjs.map +1 -1
  23. package/build/internal/cjs/index.js +19 -19
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +229 -221
  26. package/build/internal/cjs/index.typings.js +19 -19
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +229 -221
  29. package/build/internal/cjs/meta.js +19 -19
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/cjs/schemas.d.ts +2 -2
  32. package/build/internal/cjs/schemas.js +4 -4
  33. package/build/internal/cjs/schemas.js.map +1 -1
  34. package/build/internal/es/index.mjs +19 -19
  35. package/build/internal/es/index.mjs.map +1 -1
  36. package/build/internal/es/index.typings.d.mts +229 -221
  37. package/build/internal/es/index.typings.mjs +19 -19
  38. package/build/internal/es/index.typings.mjs.map +1 -1
  39. package/build/internal/es/meta.d.mts +229 -221
  40. package/build/internal/es/meta.mjs +19 -19
  41. package/build/internal/es/meta.mjs.map +1 -1
  42. package/build/internal/es/schemas.d.mts +2 -2
  43. package/build/internal/es/schemas.mjs +4 -4
  44. package/build/internal/es/schemas.mjs.map +1 -1
  45. package/package.json +2 -2
@@ -259,7 +259,15 @@ interface Tag {
259
259
  meta?: Record<string, any> | null;
260
260
  /** SEO tag inner content. For example, `<title> inner content </title>`. */
261
261
  children?: string;
262
- /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
262
+ /**
263
+ * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
264
+ *
265
+ * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
266
+ * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
267
+ * or Wix Studio pages, so custom tags saved on those pages are missing from the response entirely. For
268
+ * those pages `false` therefore does not mean "not a custom tag" — it means this API could not tell.
269
+ * Pass `seoData` explicitly to resolve against a known set of tags.
270
+ */
263
271
  custom?: boolean;
264
272
  /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
265
273
  disabled?: boolean;
@@ -3447,6 +3455,172 @@ interface GetTotalPostsResponse {
3447
3455
  /** Total amount of published posts. */
3448
3456
  total?: number;
3449
3457
  }
3458
+ interface ListDemoPostsRequest {
3459
+ /**
3460
+ * Whether to return only featured posts.
3461
+ *
3462
+ * Default: `false`
3463
+ */
3464
+ featured?: boolean;
3465
+ /**
3466
+ * Hashtag filter.
3467
+ *
3468
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3469
+ * If omitted, all posts with or without hashtags are returned.
3470
+ * @maxSize 100
3471
+ * @maxLength 100
3472
+ */
3473
+ hashtags?: string[];
3474
+ /**
3475
+ * Category filter.
3476
+ *
3477
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3478
+ * If omitted, all posts with or without associated categories are returned.
3479
+ * @maxSize 50
3480
+ * @format GUID
3481
+ */
3482
+ categoryIds?: string[];
3483
+ /**
3484
+ * Tag filter.
3485
+ *
3486
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3487
+ * If omitted, all posts with or without tags are returned.
3488
+ * @maxSize 50
3489
+ * @format GUID
3490
+ */
3491
+ tagIds?: string[];
3492
+ /**
3493
+ * Sorting options.
3494
+ *
3495
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3496
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3497
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3498
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3499
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3500
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3501
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3502
+ * - `RATING`: reserved for internal use.
3503
+ *
3504
+ * Default: `FEED`
3505
+ */
3506
+ sort?: GetPostsSortWithLiterals;
3507
+ /** Pagination options. */
3508
+ paging?: BlogPaging;
3509
+ /**
3510
+ * __Deprecated.__ Use `fieldsets` instead.
3511
+ * This parameter will be removed on June 30, 2023.
3512
+ *
3513
+ * List of post fields to be included in the response.
3514
+ * @maxSize 20
3515
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3516
+ * This parameter will be removed on June 30, 2023.
3517
+ *
3518
+ * List of post fields to be included in the response.
3519
+ * @replacedBy fieldsets
3520
+ * @targetRemovalDate 2024-06-30
3521
+ */
3522
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3523
+ /**
3524
+ * Language filter.
3525
+ *
3526
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3527
+ * Pass a language to only receive posts that are in that language.
3528
+ * If omitted, posts in all languages are returned.
3529
+ * @format LANGUAGE_TAG
3530
+ */
3531
+ language?: string | null;
3532
+ /**
3533
+ * Post owner's member ID.
3534
+ * @format GUID
3535
+ */
3536
+ memberId?: string | null;
3537
+ /**
3538
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3539
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3540
+ * only the post’s base fields are returned.
3541
+ * @maxSize 20
3542
+ */
3543
+ fieldsets?: PostFieldFieldWithLiterals[];
3544
+ }
3545
+ declare enum GetPostsSort {
3546
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3547
+ FEED = "FEED",
3548
+ /** Ordered by `firstPublishedDate` in ascending order. */
3549
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3550
+ /** Ordered by `firstPublishedDate` in descending order. */
3551
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3552
+ /** Ordered by total number of views in descending order. */
3553
+ VIEW_COUNT = "VIEW_COUNT",
3554
+ /** Ordered by total number of likes in descending order. */
3555
+ LIKE_COUNT = "LIKE_COUNT",
3556
+ /** Ordered by `title` in ascending order. */
3557
+ TITLE_ASC = "TITLE_ASC",
3558
+ /** Ordered by `title` in descending order. */
3559
+ TITLE_DESC = "TITLE_DESC"
3560
+ }
3561
+ /** @enumType */
3562
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3563
+ interface BlogPaging {
3564
+ /**
3565
+ * Number of items to skip in the current sort order.
3566
+ *
3567
+ *
3568
+ * Default: `0`
3569
+ */
3570
+ offset?: number;
3571
+ /**
3572
+ * Number of items to return.
3573
+ *
3574
+ *
3575
+ * Default:`50`
3576
+ * @min 1
3577
+ * @max 100
3578
+ */
3579
+ limit?: number;
3580
+ /**
3581
+ * Pointer to the next or previous page in the list of results.
3582
+ * @maxLength 2000
3583
+ */
3584
+ cursor?: string | null;
3585
+ }
3586
+ declare enum PostFieldField {
3587
+ UNKNOWN = "UNKNOWN",
3588
+ /** Includes post URL when present. */
3589
+ URL = "URL",
3590
+ /** Includes post content text string when present. */
3591
+ CONTENT_TEXT = "CONTENT_TEXT",
3592
+ /** Includes post metrics when present. */
3593
+ METRICS = "METRICS",
3594
+ /** Includes SEO data. */
3595
+ SEO = "SEO",
3596
+ /** Includes post owner's contact ID. */
3597
+ CONTACT_ID = "CONTACT_ID",
3598
+ /** Includes post rich content. */
3599
+ RICH_CONTENT = "RICH_CONTENT",
3600
+ /** Includes post reference ID field. */
3601
+ REFERENCE_ID = "REFERENCE_ID"
3602
+ }
3603
+ /** @enumType */
3604
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3605
+ interface ListDemoPostsResponse {
3606
+ /** List of posts. */
3607
+ posts?: Post[];
3608
+ /** Details on the paged set of results returned. */
3609
+ metaData?: MetaData;
3610
+ }
3611
+ interface MetaData {
3612
+ /** Number of items returned in this response. */
3613
+ count?: number;
3614
+ /** Requested offset. */
3615
+ offset?: number;
3616
+ /** Total number of items that match the query. */
3617
+ total?: number;
3618
+ /**
3619
+ * Pointer to the next or previous page in the list of results.
3620
+ * @maxLength 2000
3621
+ */
3622
+ cursor?: string | null;
3623
+ }
3450
3624
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3451
3625
  /**
3452
3626
  * Member ID of person who triggered the counter update
@@ -3516,25 +3690,6 @@ interface GetPostRequest {
3516
3690
  */
3517
3691
  fieldsets?: PostFieldFieldWithLiterals[];
3518
3692
  }
3519
- declare enum PostFieldField {
3520
- UNKNOWN = "UNKNOWN",
3521
- /** Includes post URL when present. */
3522
- URL = "URL",
3523
- /** Includes post content text string when present. */
3524
- CONTENT_TEXT = "CONTENT_TEXT",
3525
- /** Includes post metrics when present. */
3526
- METRICS = "METRICS",
3527
- /** Includes SEO data. */
3528
- SEO = "SEO",
3529
- /** Includes post owner's contact ID. */
3530
- CONTACT_ID = "CONTACT_ID",
3531
- /** Includes post rich content. */
3532
- RICH_CONTENT = "RICH_CONTENT",
3533
- /** Includes post reference ID field. */
3534
- REFERENCE_ID = "REFERENCE_ID"
3535
- }
3536
- /** @enumType */
3537
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3538
3693
  interface GetPostResponse {
3539
3694
  /** Retrieved post info. */
3540
3695
  post?: Post;
@@ -3627,66 +3782,12 @@ interface ListPostsRequest {
3627
3782
  */
3628
3783
  fieldsets?: PostFieldFieldWithLiterals[];
3629
3784
  }
3630
- declare enum GetPostsSort {
3631
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3632
- FEED = "FEED",
3633
- /** Ordered by `firstPublishedDate` in ascending order. */
3634
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3635
- /** Ordered by `firstPublishedDate` in descending order. */
3636
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3637
- /** Ordered by total number of views in descending order. */
3638
- VIEW_COUNT = "VIEW_COUNT",
3639
- /** Ordered by total number of likes in descending order. */
3640
- LIKE_COUNT = "LIKE_COUNT",
3641
- /** Ordered by `title` in ascending order. */
3642
- TITLE_ASC = "TITLE_ASC",
3643
- /** Ordered by `title` in descending order. */
3644
- TITLE_DESC = "TITLE_DESC"
3645
- }
3646
- /** @enumType */
3647
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3648
- interface BlogPaging {
3649
- /**
3650
- * Number of items to skip in the current sort order.
3651
- *
3652
- *
3653
- * Default: `0`
3654
- */
3655
- offset?: number;
3656
- /**
3657
- * Number of items to return.
3658
- *
3659
- *
3660
- * Default:`50`
3661
- * @min 1
3662
- * @max 100
3663
- */
3664
- limit?: number;
3665
- /**
3666
- * Pointer to the next or previous page in the list of results.
3667
- * @maxLength 2000
3668
- */
3669
- cursor?: string | null;
3670
- }
3671
3785
  interface ListPostsResponse {
3672
3786
  /** List of retrieved posts. */
3673
3787
  posts?: Post[];
3674
3788
  /** Details on the paged set of results returned. */
3675
3789
  metaData?: MetaData;
3676
3790
  }
3677
- interface MetaData {
3678
- /** Number of items returned in this response. */
3679
- count?: number;
3680
- /** Requested offset. */
3681
- offset?: number;
3682
- /** Total number of items that match the query. */
3683
- total?: number;
3684
- /**
3685
- * Pointer to the next or previous page in the list of results.
3686
- * @maxLength 2000
3687
- */
3688
- cursor?: string | null;
3689
- }
3690
3791
  interface QueryPostsRequest {
3691
3792
  /** Query options. */
3692
3793
  query?: PlatformQuery;
@@ -4041,99 +4142,6 @@ interface PostCount {
4041
4142
  /** Number of posts. */
4042
4143
  postCount?: number;
4043
4144
  }
4044
- interface ListDemoPostsRequest {
4045
- /**
4046
- * Whether to return only featured posts.
4047
- *
4048
- * Default: `false`
4049
- */
4050
- featured?: boolean;
4051
- /**
4052
- * Hashtag filter.
4053
- *
4054
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4055
- * If omitted, all posts with or without hashtags are returned.
4056
- * @maxSize 100
4057
- * @maxLength 100
4058
- */
4059
- hashtags?: string[];
4060
- /**
4061
- * Category filter.
4062
- *
4063
- * Pass an array of category IDs to return only posts with any of the provided categories.
4064
- * If omitted, all posts with or without associated categories are returned.
4065
- * @maxSize 50
4066
- * @format GUID
4067
- */
4068
- categoryIds?: string[];
4069
- /**
4070
- * Tag filter.
4071
- *
4072
- * Pass an array of tag IDs to return only posts with any of the provided tags.
4073
- * If omitted, all posts with or without tags are returned.
4074
- * @maxSize 50
4075
- * @format GUID
4076
- */
4077
- tagIds?: string[];
4078
- /**
4079
- * Sorting options.
4080
- *
4081
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4082
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4083
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4084
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4085
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4086
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
4087
- * - `TITLE_DESC`: Ordered by `title` in descending order.
4088
- * - `RATING`: reserved for internal use.
4089
- *
4090
- * Default: `FEED`
4091
- */
4092
- sort?: GetPostsSortWithLiterals;
4093
- /** Pagination options. */
4094
- paging?: BlogPaging;
4095
- /**
4096
- * __Deprecated.__ Use `fieldsets` instead.
4097
- * This parameter will be removed on June 30, 2023.
4098
- *
4099
- * List of post fields to be included in the response.
4100
- * @maxSize 20
4101
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4102
- * This parameter will be removed on June 30, 2023.
4103
- *
4104
- * List of post fields to be included in the response.
4105
- * @replacedBy fieldsets
4106
- * @targetRemovalDate 2024-06-30
4107
- */
4108
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4109
- /**
4110
- * Language filter.
4111
- *
4112
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4113
- * Pass a language to only receive posts that are in that language.
4114
- * If omitted, posts in all languages are returned.
4115
- * @format LANGUAGE_TAG
4116
- */
4117
- language?: string | null;
4118
- /**
4119
- * Post owner's member ID.
4120
- * @format GUID
4121
- */
4122
- memberId?: string | null;
4123
- /**
4124
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4125
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4126
- * only the post’s base fields are returned.
4127
- * @maxSize 20
4128
- */
4129
- fieldsets?: PostFieldFieldWithLiterals[];
4130
- }
4131
- interface ListDemoPostsResponse {
4132
- /** List of posts. */
4133
- posts?: Post[];
4134
- /** Details on the paged set of results returned. */
4135
- metaData?: MetaData;
4136
- }
4137
4145
 
4138
4146
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4139
4147
  getUrl: (context: any) => string;
package/build/es/meta.mjs CHANGED
@@ -1580,14 +1580,17 @@ var Order = /* @__PURE__ */ ((Order2) => {
1580
1580
  Order2["NEWEST"] = "NEWEST";
1581
1581
  return Order2;
1582
1582
  })(Order || {});
1583
- var Field = /* @__PURE__ */ ((Field2) => {
1584
- Field2["UNKNOWN"] = "UNKNOWN";
1585
- Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1586
- Field2["LIKE_COUNT"] = "LIKE_COUNT";
1587
- Field2["VIEW_COUNT"] = "VIEW_COUNT";
1588
- Field2["RATING_COUNT"] = "RATING_COUNT";
1589
- return Field2;
1590
- })(Field || {});
1583
+ var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1584
+ GetPostsSort2["FEED"] = "FEED";
1585
+ GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1586
+ GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1587
+ GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1588
+ GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1589
+ GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1590
+ GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1591
+ GetPostsSort2["RATING"] = "RATING";
1592
+ return GetPostsSort2;
1593
+ })(GetPostsSort || {});
1591
1594
  var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1592
1595
  PostFieldField2["UNKNOWN"] = "UNKNOWN";
1593
1596
  PostFieldField2["COUNTERS"] = "COUNTERS";
@@ -1611,17 +1614,14 @@ var PostFieldField = /* @__PURE__ */ ((PostFieldField2) => {
1611
1614
  PostFieldField2["IMAGE"] = "IMAGE";
1612
1615
  return PostFieldField2;
1613
1616
  })(PostFieldField || {});
1614
- var GetPostsSort = /* @__PURE__ */ ((GetPostsSort2) => {
1615
- GetPostsSort2["FEED"] = "FEED";
1616
- GetPostsSort2["PUBLISHED_DATE_ASC"] = "PUBLISHED_DATE_ASC";
1617
- GetPostsSort2["PUBLISHED_DATE_DESC"] = "PUBLISHED_DATE_DESC";
1618
- GetPostsSort2["VIEW_COUNT"] = "VIEW_COUNT";
1619
- GetPostsSort2["LIKE_COUNT"] = "LIKE_COUNT";
1620
- GetPostsSort2["TITLE_ASC"] = "TITLE_ASC";
1621
- GetPostsSort2["TITLE_DESC"] = "TITLE_DESC";
1622
- GetPostsSort2["RATING"] = "RATING";
1623
- return GetPostsSort2;
1624
- })(GetPostsSort || {});
1617
+ var Field = /* @__PURE__ */ ((Field2) => {
1618
+ Field2["UNKNOWN"] = "UNKNOWN";
1619
+ Field2["TOTAL_COMMENTS"] = "TOTAL_COMMENTS";
1620
+ Field2["LIKE_COUNT"] = "LIKE_COUNT";
1621
+ Field2["VIEW_COUNT"] = "VIEW_COUNT";
1622
+ Field2["RATING_COUNT"] = "RATING_COUNT";
1623
+ return Field2;
1624
+ })(Field || {});
1625
1625
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
1626
1626
  SortOrder2["ASC"] = "ASC";
1627
1627
  SortOrder2["DESC"] = "DESC";