@wix/blog 1.0.324 → 1.0.326

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/blog",
3
- "version": "1.0.324",
3
+ "version": "1.0.326",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -23,10 +23,10 @@
23
23
  "dependencies": {
24
24
  "@wix/blog_blog-cache": "1.0.10",
25
25
  "@wix/blog_blog-importer": "1.0.23",
26
- "@wix/blog_categories": "1.0.50",
27
- "@wix/blog_draft-posts": "1.0.51",
28
- "@wix/blog_posts": "1.0.57",
29
- "@wix/blog_tags": "1.0.53"
26
+ "@wix/blog_categories": "1.0.51",
27
+ "@wix/blog_draft-posts": "1.0.52",
28
+ "@wix/blog_posts": "1.0.58",
29
+ "@wix/blog_tags": "1.0.54"
30
30
  },
31
31
  "devDependencies": {
32
32
  "glob": "^10.4.1",
@@ -51,5 +51,5 @@
51
51
  "fqdn": ""
52
52
  }
53
53
  },
54
- "falconPackageHash": "334f87e04fedf7265df2dec28091af52bd79bf000665e7e4a504eaad"
54
+ "falconPackageHash": "0fea8ec9db373d292b26966ca6a186b4b0533c2bb1868338da5a3e8f"
55
55
  }
@@ -1509,13 +1509,13 @@ interface Settings$3 {
1509
1509
  keywords?: Keyword$3[];
1510
1510
  }
1511
1511
  interface CategoryTranslation$2 {
1512
- /** Category ID */
1512
+ /** Category ID. */
1513
1513
  _id?: string;
1514
- /** Label which is presented in the categories menu on site */
1514
+ /** Label displayed in the categories menu on the site. */
1515
1515
  label?: string | null;
1516
- /** Language of the category */
1516
+ /** Language of the category. */
1517
1517
  language?: string | null;
1518
- /** Url of this category page */
1518
+ /** URL of this category page. */
1519
1519
  url?: string;
1520
1520
  }
1521
1521
  interface InitialCategoriesCopied {
@@ -1526,9 +1526,11 @@ interface CreateCategoryRequest {
1526
1526
  /** Category info. */
1527
1527
  category?: Category$2;
1528
1528
  /**
1529
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1530
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1531
- * only the category’s base fields are returned.
1529
+ * List of additional category fields to include in the response. By default
1530
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1531
+ *
1532
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1533
+ * retrieve the url field in the response in addition to the category’s base fields.
1532
1534
  */
1533
1535
  fieldsets?: Field$3[];
1534
1536
  }
@@ -1554,9 +1556,11 @@ interface BulkCreateCategoriesRequest {
1554
1556
  /** Whether to return the full created category entities in the response. */
1555
1557
  returnFullEntity?: boolean;
1556
1558
  /**
1557
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1558
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1559
- * only the category’s base fields are returned.
1559
+ * List of additional category fields to include in the response. By default
1560
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1561
+ *
1562
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1563
+ * retrieve the url field in the response in addition to the category’s base fields.
1560
1564
  */
1561
1565
  fieldsets?: Field$3[];
1562
1566
  }
@@ -1604,9 +1608,11 @@ interface BulkUpdateCategoriesRequest {
1604
1608
  /** Whether to return the full created category entities in the response. */
1605
1609
  returnFullEntity?: boolean;
1606
1610
  /**
1607
- * List of category fields to be included in the response if the entities are present.
1608
- * Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
1609
- * For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
1611
+ * List of additional category fields to include in the response. By default
1612
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1613
+ *
1614
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1615
+ * retrieve the url field in the response in addition to the category’s base fields.
1610
1616
  */
1611
1617
  fieldsets?: Field$3[];
1612
1618
  }
@@ -1624,9 +1630,11 @@ interface UpdateCategoryRequest {
1624
1630
  /** Category info. */
1625
1631
  category?: Category$2;
1626
1632
  /**
1627
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1628
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1629
- * only the category’s base fields are returned.
1633
+ * List of additional category fields to include in the response. By default
1634
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1635
+ *
1636
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1637
+ * retrieve the url field in the response in addition to the category’s base fields.
1630
1638
  */
1631
1639
  fieldsets?: Field$3[];
1632
1640
  }
@@ -1650,9 +1658,11 @@ interface GetCategoryRequest {
1650
1658
  /** Category ID. */
1651
1659
  categoryId: string;
1652
1660
  /**
1653
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1654
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1655
- * only the category’s base fields are returned.
1661
+ * List of additional category fields to include in the response. By default
1662
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1663
+ *
1664
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1665
+ * retrieve the url field in the response in addition to the category’s base fields.
1656
1666
  */
1657
1667
  fieldsets?: Field$3[];
1658
1668
  }
@@ -1664,9 +1674,11 @@ interface GetCategoryBySlugRequest {
1664
1674
  /** Slug of the category to retrieve. */
1665
1675
  slug: string;
1666
1676
  /**
1667
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1668
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1669
- * only the category’s base fields are returned.
1677
+ * List of additional category fields to include in the response. By default
1678
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1679
+ *
1680
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1681
+ * retrieve the url field in the response in addition to the category’s base fields.
1670
1682
  */
1671
1683
  fieldsets?: Field$3[];
1672
1684
  /**
@@ -1683,9 +1695,11 @@ interface ListCategoriesRequest {
1683
1695
  /** Pagination options. */
1684
1696
  paging?: BlogPaging$2;
1685
1697
  /**
1686
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1687
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1688
- * only the category’s base fields are returned.
1698
+ * List of additional category fields to include in the response. By default
1699
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1700
+ *
1701
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1702
+ * retrieve the url field in the response in addition to the category’s base fields.
1689
1703
  */
1690
1704
  fieldsets?: Field$3[];
1691
1705
  /**
@@ -1731,9 +1745,11 @@ interface QueryCategoriesRequest {
1731
1745
  /** Query options. */
1732
1746
  query?: PlatformQuery$3;
1733
1747
  /**
1734
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1735
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1736
- * only the category’s base fields are returned.
1748
+ * List of additional category fields to include in the response. By default
1749
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1750
+ *
1751
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1752
+ * retrieve the url field in the response in addition to the category’s base fields.
1737
1753
  */
1738
1754
  fieldsets?: Field$3[];
1739
1755
  }
@@ -4560,7 +4576,7 @@ interface Category$1 {
4560
4576
  */
4561
4577
  postCount?: number;
4562
4578
  /**
4563
- * Category URL.
4579
+ * The `url` of the page that lists every post with the specified category.
4564
4580
  * @readonly
4565
4581
  */
4566
4582
  url?: string;
@@ -4569,7 +4585,8 @@ interface Category$1 {
4569
4585
  /** Category title. */
4570
4586
  title?: string;
4571
4587
  /**
4572
- * Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of `-1` appear at the end of the sequence.
4588
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
4589
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
4573
4590
  *
4574
4591
  * Default: `-1`
4575
4592
  */
@@ -4582,7 +4599,7 @@ interface Category$1 {
4582
4599
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4583
4600
  */
4584
4601
  language?: string | null;
4585
- /** Category slug. For example, `'category-slug'`. */
4602
+ /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */
4586
4603
  slug?: string;
4587
4604
  /**
4588
4605
  * Reserved for internal use.
@@ -4600,13 +4617,13 @@ interface Category$1 {
4600
4617
  _updatedDate?: Date | null;
4601
4618
  }
4602
4619
  interface CategoryTranslation$1 {
4603
- /** Category ID */
4620
+ /** Category ID. */
4604
4621
  _id?: string;
4605
- /** Label which is presented in the categories menu on site */
4622
+ /** Label displayed in the categories menu on the site. */
4606
4623
  label?: string | null;
4607
- /** Language of the category */
4624
+ /** Language of the category. */
4608
4625
  language?: string | null;
4609
- /** Url of this category page */
4626
+ /** URL of this category page. */
4610
4627
  url?: string;
4611
4628
  }
4612
4629
  interface TranslateDraftRequest {
@@ -7681,7 +7698,7 @@ interface Category {
7681
7698
  */
7682
7699
  postCount?: number;
7683
7700
  /**
7684
- * Category URL.
7701
+ * The `url` of the page that lists every post with the specified category.
7685
7702
  * @readonly
7686
7703
  */
7687
7704
  url?: string;
@@ -7690,7 +7707,8 @@ interface Category {
7690
7707
  /** Category title. */
7691
7708
  title?: string;
7692
7709
  /**
7693
- * Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of `-1` appear at the end of the sequence.
7710
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
7711
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
7694
7712
  *
7695
7713
  * Default: `-1`
7696
7714
  */
@@ -7703,7 +7721,7 @@ interface Category {
7703
7721
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
7704
7722
  */
7705
7723
  language?: string | null;
7706
- /** Category slug. For example, `'category-slug'`. */
7724
+ /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */
7707
7725
  slug?: string;
7708
7726
  /**
7709
7727
  * Reserved for internal use.
@@ -7721,13 +7739,13 @@ interface Category {
7721
7739
  _updatedDate?: Date | null;
7722
7740
  }
7723
7741
  interface CategoryTranslation {
7724
- /** Category ID */
7742
+ /** Category ID. */
7725
7743
  _id?: string;
7726
- /** Label which is presented in the categories menu on site */
7744
+ /** Label displayed in the categories menu on the site. */
7727
7745
  label?: string | null;
7728
- /** Language of the category */
7746
+ /** Language of the category. */
7729
7747
  language?: string | null;
7730
- /** Url of this category page */
7748
+ /** URL of this category page. */
7731
7749
  url?: string;
7732
7750
  }
7733
7751
  interface GetTemplateRequest {
@@ -9842,14 +9860,6 @@ interface BlogTag {
9842
9860
  * @readonly
9843
9861
  */
9844
9862
  _updatedDate?: Date | null;
9845
- /**
9846
- * Reserved for internal use.
9847
- * @readonly
9848
- * @deprecated
9849
- * @replacedBy published_post_count
9850
- * @targetRemovalDate 2024-06-30
9851
- */
9852
- publicationCount?: number;
9853
9863
  /**
9854
9864
  * Number of posts with this tag, including unpublished draft posts.
9855
9865
  * @readonly
@@ -10380,7 +10390,6 @@ interface BlogTagNonNullableFields {
10380
10390
  _id: string;
10381
10391
  label: string;
10382
10392
  slug: string;
10383
- publicationCount: number;
10384
10393
  postCount: number;
10385
10394
  url: string;
10386
10395
  publishedPostCount: number;
@@ -10521,27 +10530,27 @@ interface TagsQueryBuilder {
10521
10530
  /** @param propertyName - Property whose value is compared with `value`.
10522
10531
  * @param value - Value to compare against.
10523
10532
  */
10524
- eq: (propertyName: '_id' | 'label' | 'slug' | 'publicationCount' | 'postCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10533
+ eq: (propertyName: '_id' | 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10525
10534
  /** @param propertyName - Property whose value is compared with `value`.
10526
10535
  * @param value - Value to compare against.
10527
10536
  */
10528
- ne: (propertyName: '_id' | 'label' | 'slug' | 'publicationCount' | 'postCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10537
+ ne: (propertyName: '_id' | 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10529
10538
  /** @param propertyName - Property whose value is compared with `value`.
10530
10539
  * @param value - Value to compare against.
10531
10540
  */
10532
- ge: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10541
+ ge: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10533
10542
  /** @param propertyName - Property whose value is compared with `value`.
10534
10543
  * @param value - Value to compare against.
10535
10544
  */
10536
- gt: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10545
+ gt: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10537
10546
  /** @param propertyName - Property whose value is compared with `value`.
10538
10547
  * @param value - Value to compare against.
10539
10548
  */
10540
- le: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10549
+ le: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10541
10550
  /** @param propertyName - Property whose value is compared with `value`.
10542
10551
  * @param value - Value to compare against.
10543
10552
  */
10544
- lt: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10553
+ lt: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10545
10554
  /** @param propertyName - Property whose value is compared with `string`.
10546
10555
  * @param string - String to compare against. Case-insensitive.
10547
10556
  */
@@ -10550,12 +10559,12 @@ interface TagsQueryBuilder {
10550
10559
  * @param values - List of values to compare against.
10551
10560
  */
10552
10561
  hasSome: (propertyName: '_id' | 'label' | 'slug', value: any[]) => TagsQueryBuilder;
10553
- in: (propertyName: 'label' | 'slug' | 'publicationCount' | 'postCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10562
+ in: (propertyName: 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10554
10563
  exists: (propertyName: 'label' | 'slug' | 'translationId' | 'language', value: boolean) => TagsQueryBuilder;
10555
10564
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
10556
- ascending: (...propertyNames: Array<'label' | 'slug' | 'publicationCount' | 'postCount' | 'language'>) => TagsQueryBuilder;
10565
+ ascending: (...propertyNames: Array<'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'language'>) => TagsQueryBuilder;
10557
10566
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
10558
- descending: (...propertyNames: Array<'label' | 'slug' | 'publicationCount' | 'postCount' | 'language'>) => TagsQueryBuilder;
10567
+ descending: (...propertyNames: Array<'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'language'>) => TagsQueryBuilder;
10559
10568
  /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
10560
10569
  limit: (limit: number) => TagsQueryBuilder;
10561
10570
  /** @param skip - Number of items to skip in the query results before returning the results. */
@@ -1509,13 +1509,13 @@ interface Settings$3 {
1509
1509
  keywords?: Keyword$3[];
1510
1510
  }
1511
1511
  interface CategoryTranslation$2 {
1512
- /** Category ID */
1512
+ /** Category ID. */
1513
1513
  _id?: string;
1514
- /** Label which is presented in the categories menu on site */
1514
+ /** Label displayed in the categories menu on the site. */
1515
1515
  label?: string | null;
1516
- /** Language of the category */
1516
+ /** Language of the category. */
1517
1517
  language?: string | null;
1518
- /** Url of this category page */
1518
+ /** URL of this category page. */
1519
1519
  url?: string;
1520
1520
  }
1521
1521
  interface InitialCategoriesCopied {
@@ -1526,9 +1526,11 @@ interface CreateCategoryRequest {
1526
1526
  /** Category info. */
1527
1527
  category?: Category$2;
1528
1528
  /**
1529
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1530
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1531
- * only the category’s base fields are returned.
1529
+ * List of additional category fields to include in the response. By default
1530
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1531
+ *
1532
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1533
+ * retrieve the url field in the response in addition to the category’s base fields.
1532
1534
  */
1533
1535
  fieldsets?: Field$3[];
1534
1536
  }
@@ -1554,9 +1556,11 @@ interface BulkCreateCategoriesRequest {
1554
1556
  /** Whether to return the full created category entities in the response. */
1555
1557
  returnFullEntity?: boolean;
1556
1558
  /**
1557
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1558
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1559
- * only the category’s base fields are returned.
1559
+ * List of additional category fields to include in the response. By default
1560
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1561
+ *
1562
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1563
+ * retrieve the url field in the response in addition to the category’s base fields.
1560
1564
  */
1561
1565
  fieldsets?: Field$3[];
1562
1566
  }
@@ -1604,9 +1608,11 @@ interface BulkUpdateCategoriesRequest {
1604
1608
  /** Whether to return the full created category entities in the response. */
1605
1609
  returnFullEntity?: boolean;
1606
1610
  /**
1607
- * List of category fields to be included in the response if the entities are present.
1608
- * Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
1609
- * For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
1611
+ * List of additional category fields to include in the response. By default
1612
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1613
+ *
1614
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1615
+ * retrieve the url field in the response in addition to the category’s base fields.
1610
1616
  */
1611
1617
  fieldsets?: Field$3[];
1612
1618
  }
@@ -1624,9 +1630,11 @@ interface UpdateCategoryRequest {
1624
1630
  /** Category info. */
1625
1631
  category?: Category$2;
1626
1632
  /**
1627
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1628
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1629
- * only the category’s base fields are returned.
1633
+ * List of additional category fields to include in the response. By default
1634
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1635
+ *
1636
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1637
+ * retrieve the url field in the response in addition to the category’s base fields.
1630
1638
  */
1631
1639
  fieldsets?: Field$3[];
1632
1640
  }
@@ -1650,9 +1658,11 @@ interface GetCategoryRequest {
1650
1658
  /** Category ID. */
1651
1659
  categoryId: string;
1652
1660
  /**
1653
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1654
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1655
- * only the category’s base fields are returned.
1661
+ * List of additional category fields to include in the response. By default
1662
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1663
+ *
1664
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1665
+ * retrieve the url field in the response in addition to the category’s base fields.
1656
1666
  */
1657
1667
  fieldsets?: Field$3[];
1658
1668
  }
@@ -1664,9 +1674,11 @@ interface GetCategoryBySlugRequest {
1664
1674
  /** Slug of the category to retrieve. */
1665
1675
  slug: string;
1666
1676
  /**
1667
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1668
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1669
- * only the category’s base fields are returned.
1677
+ * List of additional category fields to include in the response. By default
1678
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1679
+ *
1680
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1681
+ * retrieve the url field in the response in addition to the category’s base fields.
1670
1682
  */
1671
1683
  fieldsets?: Field$3[];
1672
1684
  /**
@@ -1683,9 +1695,11 @@ interface ListCategoriesRequest {
1683
1695
  /** Pagination options. */
1684
1696
  paging?: BlogPaging$2;
1685
1697
  /**
1686
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1687
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1688
- * only the category’s base fields are returned.
1698
+ * List of additional category fields to include in the response. By default
1699
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1700
+ *
1701
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1702
+ * retrieve the url field in the response in addition to the category’s base fields.
1689
1703
  */
1690
1704
  fieldsets?: Field$3[];
1691
1705
  /**
@@ -1731,9 +1745,11 @@ interface QueryCategoriesRequest {
1731
1745
  /** Query options. */
1732
1746
  query?: PlatformQuery$3;
1733
1747
  /**
1734
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1735
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1736
- * only the category’s base fields are returned.
1748
+ * List of additional category fields to include in the response. By default
1749
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1750
+ *
1751
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1752
+ * retrieve the url field in the response in addition to the category’s base fields.
1737
1753
  */
1738
1754
  fieldsets?: Field$3[];
1739
1755
  }
@@ -4560,7 +4576,7 @@ interface Category$1 {
4560
4576
  */
4561
4577
  postCount?: number;
4562
4578
  /**
4563
- * Category URL.
4579
+ * The `url` of the page that lists every post with the specified category.
4564
4580
  * @readonly
4565
4581
  */
4566
4582
  url?: string;
@@ -4569,7 +4585,8 @@ interface Category$1 {
4569
4585
  /** Category title. */
4570
4586
  title?: string;
4571
4587
  /**
4572
- * Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of `-1` appear at the end of the sequence.
4588
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
4589
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
4573
4590
  *
4574
4591
  * Default: `-1`
4575
4592
  */
@@ -4582,7 +4599,7 @@ interface Category$1 {
4582
4599
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4583
4600
  */
4584
4601
  language?: string | null;
4585
- /** Category slug. For example, `'category-slug'`. */
4602
+ /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */
4586
4603
  slug?: string;
4587
4604
  /**
4588
4605
  * Reserved for internal use.
@@ -4600,13 +4617,13 @@ interface Category$1 {
4600
4617
  _updatedDate?: Date | null;
4601
4618
  }
4602
4619
  interface CategoryTranslation$1 {
4603
- /** Category ID */
4620
+ /** Category ID. */
4604
4621
  _id?: string;
4605
- /** Label which is presented in the categories menu on site */
4622
+ /** Label displayed in the categories menu on the site. */
4606
4623
  label?: string | null;
4607
- /** Language of the category */
4624
+ /** Language of the category. */
4608
4625
  language?: string | null;
4609
- /** Url of this category page */
4626
+ /** URL of this category page. */
4610
4627
  url?: string;
4611
4628
  }
4612
4629
  interface TranslateDraftRequest {
@@ -7681,7 +7698,7 @@ interface Category {
7681
7698
  */
7682
7699
  postCount?: number;
7683
7700
  /**
7684
- * Category URL.
7701
+ * The `url` of the page that lists every post with the specified category.
7685
7702
  * @readonly
7686
7703
  */
7687
7704
  url?: string;
@@ -7690,7 +7707,8 @@ interface Category {
7690
7707
  /** Category title. */
7691
7708
  title?: string;
7692
7709
  /**
7693
- * Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of `-1` appear at the end of the sequence.
7710
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
7711
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
7694
7712
  *
7695
7713
  * Default: `-1`
7696
7714
  */
@@ -7703,7 +7721,7 @@ interface Category {
7703
7721
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
7704
7722
  */
7705
7723
  language?: string | null;
7706
- /** Category slug. For example, `'category-slug'`. */
7724
+ /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */
7707
7725
  slug?: string;
7708
7726
  /**
7709
7727
  * Reserved for internal use.
@@ -7721,13 +7739,13 @@ interface Category {
7721
7739
  _updatedDate?: Date | null;
7722
7740
  }
7723
7741
  interface CategoryTranslation {
7724
- /** Category ID */
7742
+ /** Category ID. */
7725
7743
  _id?: string;
7726
- /** Label which is presented in the categories menu on site */
7744
+ /** Label displayed in the categories menu on the site. */
7727
7745
  label?: string | null;
7728
- /** Language of the category */
7746
+ /** Language of the category. */
7729
7747
  language?: string | null;
7730
- /** Url of this category page */
7748
+ /** URL of this category page. */
7731
7749
  url?: string;
7732
7750
  }
7733
7751
  interface GetTemplateRequest {
@@ -9842,14 +9860,6 @@ interface BlogTag {
9842
9860
  * @readonly
9843
9861
  */
9844
9862
  _updatedDate?: Date | null;
9845
- /**
9846
- * Reserved for internal use.
9847
- * @readonly
9848
- * @deprecated
9849
- * @replacedBy published_post_count
9850
- * @targetRemovalDate 2024-06-30
9851
- */
9852
- publicationCount?: number;
9853
9863
  /**
9854
9864
  * Number of posts with this tag, including unpublished draft posts.
9855
9865
  * @readonly
@@ -10380,7 +10390,6 @@ interface BlogTagNonNullableFields {
10380
10390
  _id: string;
10381
10391
  label: string;
10382
10392
  slug: string;
10383
- publicationCount: number;
10384
10393
  postCount: number;
10385
10394
  url: string;
10386
10395
  publishedPostCount: number;
@@ -10521,27 +10530,27 @@ interface TagsQueryBuilder {
10521
10530
  /** @param propertyName - Property whose value is compared with `value`.
10522
10531
  * @param value - Value to compare against.
10523
10532
  */
10524
- eq: (propertyName: '_id' | 'label' | 'slug' | 'publicationCount' | 'postCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10533
+ eq: (propertyName: '_id' | 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10525
10534
  /** @param propertyName - Property whose value is compared with `value`.
10526
10535
  * @param value - Value to compare against.
10527
10536
  */
10528
- ne: (propertyName: '_id' | 'label' | 'slug' | 'publicationCount' | 'postCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10537
+ ne: (propertyName: '_id' | 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10529
10538
  /** @param propertyName - Property whose value is compared with `value`.
10530
10539
  * @param value - Value to compare against.
10531
10540
  */
10532
- ge: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10541
+ ge: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10533
10542
  /** @param propertyName - Property whose value is compared with `value`.
10534
10543
  * @param value - Value to compare against.
10535
10544
  */
10536
- gt: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10545
+ gt: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10537
10546
  /** @param propertyName - Property whose value is compared with `value`.
10538
10547
  * @param value - Value to compare against.
10539
10548
  */
10540
- le: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10549
+ le: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10541
10550
  /** @param propertyName - Property whose value is compared with `value`.
10542
10551
  * @param value - Value to compare against.
10543
10552
  */
10544
- lt: (propertyName: 'publicationCount' | 'postCount', value: any) => TagsQueryBuilder;
10553
+ lt: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;
10545
10554
  /** @param propertyName - Property whose value is compared with `string`.
10546
10555
  * @param string - String to compare against. Case-insensitive.
10547
10556
  */
@@ -10550,12 +10559,12 @@ interface TagsQueryBuilder {
10550
10559
  * @param values - List of values to compare against.
10551
10560
  */
10552
10561
  hasSome: (propertyName: '_id' | 'label' | 'slug', value: any[]) => TagsQueryBuilder;
10553
- in: (propertyName: 'label' | 'slug' | 'publicationCount' | 'postCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10562
+ in: (propertyName: 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;
10554
10563
  exists: (propertyName: 'label' | 'slug' | 'translationId' | 'language', value: boolean) => TagsQueryBuilder;
10555
10564
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
10556
- ascending: (...propertyNames: Array<'label' | 'slug' | 'publicationCount' | 'postCount' | 'language'>) => TagsQueryBuilder;
10565
+ ascending: (...propertyNames: Array<'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'language'>) => TagsQueryBuilder;
10557
10566
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
10558
- descending: (...propertyNames: Array<'label' | 'slug' | 'publicationCount' | 'postCount' | 'language'>) => TagsQueryBuilder;
10567
+ descending: (...propertyNames: Array<'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'language'>) => TagsQueryBuilder;
10559
10568
  /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
10560
10569
  limit: (limit: number) => TagsQueryBuilder;
10561
10570
  /** @param skip - Number of items to skip in the query results before returning the results. */
@@ -975,7 +975,7 @@ interface Category$1 {
975
975
  */
976
976
  postCount?: number;
977
977
  /**
978
- * Category URL.
978
+ * The `url` of the page that lists every post with the specified category.
979
979
  * @readonly
980
980
  */
981
981
  url?: PageUrl$3;
@@ -984,7 +984,8 @@ interface Category$1 {
984
984
  /** Category title. */
985
985
  title?: string;
986
986
  /**
987
- * Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of `-1` appear at the end of the sequence.
987
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
988
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
988
989
  *
989
990
  * Default: `-1`
990
991
  */
@@ -997,7 +998,7 @@ interface Category$1 {
997
998
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
998
999
  */
999
1000
  language?: string | null;
1000
- /** Category slug. For example, `'category-slug'`. */
1001
+ /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */
1001
1002
  slug?: string;
1002
1003
  /**
1003
1004
  * Reserved for internal use.
@@ -1111,9 +1112,11 @@ interface GetCategoryRequest$1 {
1111
1112
  /** Category ID. */
1112
1113
  categoryId: string;
1113
1114
  /**
1114
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1115
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1116
- * only the category’s base fields are returned.
1115
+ * List of additional category fields to include in the response. By default
1116
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1117
+ *
1118
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1119
+ * retrieve the url field in the response in addition to the category’s base fields.
1117
1120
  */
1118
1121
  fieldsets?: Field$5[];
1119
1122
  }
@@ -1125,9 +1128,11 @@ interface GetCategoryBySlugRequest$1 {
1125
1128
  /** Slug of the category to retrieve. */
1126
1129
  slug: string;
1127
1130
  /**
1128
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1129
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1130
- * only the category’s base fields are returned.
1131
+ * List of additional category fields to include in the response. By default
1132
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1133
+ *
1134
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1135
+ * retrieve the url field in the response in addition to the category’s base fields.
1131
1136
  */
1132
1137
  fieldsets?: Field$5[];
1133
1138
  /**
@@ -1144,9 +1149,11 @@ interface ListCategoriesRequest$1 {
1144
1149
  /** Pagination options. */
1145
1150
  paging?: BlogPaging$5;
1146
1151
  /**
1147
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1148
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1149
- * only the category’s base fields are returned.
1152
+ * List of additional category fields to include in the response. By default
1153
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1154
+ *
1155
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1156
+ * retrieve the url field in the response in addition to the category’s base fields.
1150
1157
  */
1151
1158
  fieldsets?: Field$5[];
1152
1159
  /**
@@ -1196,9 +1203,11 @@ interface QueryCategoriesRequest$1 {
1196
1203
  /** Query options. */
1197
1204
  query?: PlatformQuery$7;
1198
1205
  /**
1199
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1200
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1201
- * only the category’s base fields are returned.
1206
+ * List of additional category fields to include in the response. By default
1207
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1208
+ *
1209
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1210
+ * retrieve the url field in the response in addition to the category’s base fields.
1202
1211
  */
1203
1212
  fieldsets?: Field$5[];
1204
1213
  }
@@ -1466,9 +1475,11 @@ interface GetCategoryRequest {
1466
1475
  /** Category ID. */
1467
1476
  categoryId: string;
1468
1477
  /**
1469
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1470
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1471
- * only the category’s base fields are returned.
1478
+ * List of additional category fields to include in the response. By default
1479
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1480
+ *
1481
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1482
+ * retrieve the url field in the response in addition to the category’s base fields.
1472
1483
  */
1473
1484
  fieldsets?: Field$4[];
1474
1485
  }
@@ -1480,9 +1491,11 @@ interface GetCategoryBySlugRequest {
1480
1491
  /** Slug of the category to retrieve. */
1481
1492
  slug: string;
1482
1493
  /**
1483
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1484
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1485
- * only the category’s base fields are returned.
1494
+ * List of additional category fields to include in the response. By default
1495
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1496
+ *
1497
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1498
+ * retrieve the url field in the response in addition to the category’s base fields.
1486
1499
  */
1487
1500
  fieldsets?: Field$4[];
1488
1501
  /**
@@ -1499,9 +1512,11 @@ interface ListCategoriesRequest {
1499
1512
  /** Pagination options. */
1500
1513
  paging?: BlogPaging$4;
1501
1514
  /**
1502
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1503
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1504
- * only the category’s base fields are returned.
1515
+ * List of additional category fields to include in the response. By default
1516
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1517
+ *
1518
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1519
+ * retrieve the url field in the response in addition to the category’s base fields.
1505
1520
  */
1506
1521
  fieldsets?: Field$4[];
1507
1522
  /**
@@ -1547,9 +1562,11 @@ interface QueryCategoriesRequest {
1547
1562
  /** Query options. */
1548
1563
  query?: PlatformQuery$6;
1549
1564
  /**
1550
- * List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1551
- * the response in addition to the category’s base fields. Base fields dont include any of the supported fieldset values. By default
1552
- * only the category’s base fields are returned.
1565
+ * List of additional category fields to include in the response. By default
1566
+ * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
1567
+ *
1568
+ * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to
1569
+ * retrieve the url field in the response in addition to the category’s base fields.
1553
1570
  */
1554
1571
  fieldsets?: Field$4[];
1555
1572
  }
@@ -11433,14 +11450,6 @@ interface BlogTag$1 {
11433
11450
  * @readonly
11434
11451
  */
11435
11452
  updatedDate?: Date | null;
11436
- /**
11437
- * Reserved for internal use.
11438
- * @readonly
11439
- * @deprecated
11440
- * @replacedBy published_post_count
11441
- * @targetRemovalDate 2024-06-30
11442
- */
11443
- publicationCount?: number;
11444
11453
  /**
11445
11454
  * Number of posts with this tag, including unpublished draft posts.
11446
11455
  * @readonly
@@ -11678,7 +11687,6 @@ interface BlogTagNonNullableFields$1 {
11678
11687
  id: string;
11679
11688
  label: string;
11680
11689
  slug: string;
11681
- publicationCount: number;
11682
11690
  postCount: number;
11683
11691
  url?: PageUrlNonNullableFields;
11684
11692
  publishedPostCount: number;
@@ -11724,14 +11732,6 @@ interface BlogTag {
11724
11732
  * @readonly
11725
11733
  */
11726
11734
  _updatedDate?: Date | null;
11727
- /**
11728
- * Reserved for internal use.
11729
- * @readonly
11730
- * @deprecated
11731
- * @replacedBy published_post_count
11732
- * @targetRemovalDate 2024-06-30
11733
- */
11734
- publicationCount?: number;
11735
11735
  /**
11736
11736
  * Number of posts with this tag, including unpublished draft posts.
11737
11737
  * @readonly
@@ -11959,7 +11959,6 @@ interface BlogTagNonNullableFields {
11959
11959
  _id: string;
11960
11960
  label: string;
11961
11961
  slug: string;
11962
- publicationCount: number;
11963
11962
  postCount: number;
11964
11963
  url: string;
11965
11964
  publishedPostCount: number;