@wix/categories 1.0.45 → 1.0.47

package/type-bundles/meta.bundle.d.ts

@@ -51,8 +51,20 @@ interface Category$1 {
      *
      * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
      * @readonly
+     * @deprecated Category breadcrumbs.
+     *
+     * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
+     * @replacedBy breadcrumbs_info
+     * @targetRemovalDate 2024-09-12
      */
     breadcrumbs?: BreadcrumbItemValues$1;
+    /**
+     * Category breadcrumbs.
+     *
+     * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
+     * @readonly
+     */
+    breadcrumbsInfo?: BreadcrumbsInfo$1;
     /** Parent category reference data. */
     parentCategory?: ParentCategory$1;
     /**
@@ -106,7 +118,7 @@ interface Image$1 {
 }
 interface BreadcrumbItemValues$1 {
     /**
-     * List of breadcrumb data.
+     * List of breadcrumb data. The current category isn't included in the list.
      * @readonly
      */
     values?: BreadcrumbItem$1[];
@@ -119,6 +131,21 @@ interface BreadcrumbItem$1 {
     /** Category slug. */
     categorySlug?: string;
 }
+interface BreadcrumbsInfo$1 {
+    /**
+     * List of breadcrumb data. The current category isn't included in the list.
+     * @readonly
+     */
+    breadcrumbs?: Breadcrumb$1[];
+}
+interface Breadcrumb$1 {
+    /** Category ID. */
+    categoryId?: string;
+    /** Category name. */
+    categoryName?: string;
+    /** Category slug. */
+    categorySlug?: string;
+}
 interface ParentCategory$1 {
     /**
      * Parent category ID.
@@ -1394,7 +1421,8 @@ declare enum SingleEntityOpsRequestedFields$1 {
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS = "BREADCRUMBS",
     DESCRIPTION = "DESCRIPTION",
-    RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
+    RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION",
+    BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
 interface CreateCategoryResponse$1 {
     /** Created category. */
@@ -1491,7 +1519,8 @@ interface CursorPaging$1 {
 }
 declare enum RequestedFields$1 {
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
-    BREADCRUMBS = "BREADCRUMBS"
+    BREADCRUMBS = "BREADCRUMBS",
+    BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
 interface QueryCategoriesResponse$1 {
     /** Categories which satisfy the provided query. */
@@ -2092,7 +2121,7 @@ interface BulkAddItemsToCategoryResponse$1 {
     bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkItemsToCategoryResult$1 {
-    /** Bulk action metadata for category. */
+    /** Bulk action metadata for item reference. */
     itemMetadata?: ItemReferenceMetadata$1;
 }
 interface ItemReferenceMetadata$1 {
@@ -2257,6 +2286,14 @@ interface BreadcrumbItemNonNullableFields$1 {
 interface BreadcrumbItemValuesNonNullableFields$1 {
     values: BreadcrumbItemNonNullableFields$1[];
 }
+interface BreadcrumbNonNullableFields$1 {
+    categoryId: string;
+    categoryName: string;
+    categorySlug: string;
+}
+interface BreadcrumbsInfoNonNullableFields$1 {
+    breadcrumbs: BreadcrumbNonNullableFields$1[];
+}
 interface TagNonNullableFields$1 {
     type: string;
     children: string;
@@ -2526,6 +2563,7 @@ interface CategoryNonNullableFields$1 {
     itemCounter: number;
     totalItemCounter: number;
     breadcrumbs?: BreadcrumbItemValuesNonNullableFields$1;
+    breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields$1;
     seoData?: SeoSchemaNonNullableFields$1;
     richContentDescription?: RichContentNonNullableFields$1;
     treeReference?: TreeReferenceNonNullableFields$1;
@@ -2731,8 +2769,20 @@ interface Category {
      *
      * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
      * @readonly
+     * @deprecated Category breadcrumbs.
+     *
+     * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
+     * @replacedBy breadcrumbs_info
+     * @targetRemovalDate 2024-09-12
      */
     breadcrumbs?: BreadcrumbItemValues;
+    /**
+     * Category breadcrumbs.
+     *
+     * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
+     * @readonly
+     */
+    breadcrumbsInfo?: BreadcrumbsInfo;
     /** Parent category reference data. */
     parentCategory?: ParentCategory;
     /**
@@ -2763,7 +2813,7 @@ interface Category {
 }
 interface BreadcrumbItemValues {
     /**
-     * List of breadcrumb data.
+     * List of breadcrumb data. The current category isn't included in the list.
      * @readonly
      */
     values?: BreadcrumbItem[];
@@ -2776,6 +2826,21 @@ interface BreadcrumbItem {
     /** Category slug. */
     categorySlug?: string;
 }
+interface BreadcrumbsInfo {
+    /**
+     * List of breadcrumb data. The current category isn't included in the list.
+     * @readonly
+     */
+    breadcrumbs?: Breadcrumb[];
+}
+interface Breadcrumb {
+    /** Category ID. */
+    categoryId?: string;
+    /** Category name. */
+    categoryName?: string;
+    /** Category slug. */
+    categorySlug?: string;
+}
 interface ParentCategory {
     /**
      * Parent category ID.
@@ -4051,7 +4116,8 @@ declare enum SingleEntityOpsRequestedFields {
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS = "BREADCRUMBS",
     DESCRIPTION = "DESCRIPTION",
-    RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
+    RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION",
+    BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
 interface CreateCategoryResponse {
     /** Created category. */
@@ -4148,7 +4214,8 @@ interface CursorPaging {
 }
 declare enum RequestedFields {
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
-    BREADCRUMBS = "BREADCRUMBS"
+    BREADCRUMBS = "BREADCRUMBS",
+    BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
 interface QueryCategoriesResponse {
     /** Categories which satisfy the provided query. */
@@ -4749,7 +4816,7 @@ interface BulkAddItemsToCategoryResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkItemsToCategoryResult {
-    /** Bulk action metadata for category. */
+    /** Bulk action metadata for item reference. */
     itemMetadata?: ItemReferenceMetadata;
 }
 interface ItemReferenceMetadata {
@@ -4908,6 +4975,14 @@ interface BreadcrumbItemNonNullableFields {
 interface BreadcrumbItemValuesNonNullableFields {
     values: BreadcrumbItemNonNullableFields[];
 }
+interface BreadcrumbNonNullableFields {
+    categoryId: string;
+    categoryName: string;
+    categorySlug: string;
+}
+interface BreadcrumbsInfoNonNullableFields {
+    breadcrumbs: BreadcrumbNonNullableFields[];
+}
 interface TagNonNullableFields {
     type: string;
     children: string;
@@ -5177,6 +5252,7 @@ interface CategoryNonNullableFields {
     itemCounter: number;
     totalItemCounter: number;
     breadcrumbs?: BreadcrumbItemValuesNonNullableFields;
+    breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields;
     seoData?: SeoSchemaNonNullableFields;
     richContentDescription?: RichContentNonNullableFields;
     treeReference?: TreeReferenceNonNullableFields;