@wix/categories 1.0.50 → 1.0.52

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

@@ -46,18 +46,6 @@ interface Category$1 {
      * + Default: `false`.
      */
     visible?: boolean | null;
-    /**
-     * Category breadcrumbs.
-     *
-     * > **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-03
-     */
-    breadcrumbs?: BreadcrumbItemValues$1;
     /**
      * Category breadcrumbs.
      *
@@ -118,21 +106,6 @@ interface Image$1 {
      */
     filename?: string | null;
 }
-interface BreadcrumbItemValues$1 {
-    /**
-     * List of breadcrumb data. The current category isn't included in the list.
-     * @readonly
-     */
-    values?: BreadcrumbItem$1[];
-}
-interface BreadcrumbItem$1 {
-    /** Category ID. */
-    categoryId?: string;
-    /** Category name. */
-    categoryName?: string;
-    /** Category slug. */
-    categorySlug?: string;
-}
 interface BreadcrumbsInfo$1 {
     /**
      * List of breadcrumb data. The current category isn't included in the list.
@@ -1470,8 +1443,9 @@ interface QueryCategoriesRequest$1 {
     /** Category tree reference details. */
     treeReference: TreeReference$1;
     /**
-     * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
-     * Used only in the first request. Following requests use the cursor token.
+     * Whether to return non-visible categories.
+     *
+     * Default: `false` (only visible categories are returned)
      */
     returnNonVisibleCategories?: boolean;
     /** Fields to include in the response. */
@@ -1527,7 +1501,7 @@ declare enum RequestedFields$1 {
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
 interface QueryCategoriesResponse$1 {
-    /** Categories which satisfy the provided query. */
+    /** List of categories. */
     categories?: Category$1[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$1;
@@ -2282,14 +2256,6 @@ interface ImageNonNullableFields$1 {
     height: number;
     width: number;
 }
-interface BreadcrumbItemNonNullableFields$1 {
-    categoryId: string;
-    categoryName: string;
-    categorySlug: string;
-}
-interface BreadcrumbItemValuesNonNullableFields$1 {
-    values: BreadcrumbItemNonNullableFields$1[];
-}
 interface BreadcrumbNonNullableFields$1 {
     categoryId: string;
     categoryName: string;
@@ -2566,7 +2532,6 @@ interface CategoryNonNullableFields$1 {
     image?: ImageNonNullableFields$1;
     itemCounter: number;
     totalItemCounter: number;
-    breadcrumbs?: BreadcrumbItemValuesNonNullableFields$1;
     breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields$1;
     seoData?: SeoSchemaNonNullableFields$1;
     richContentDescription?: RichContentNonNullableFields$1;
@@ -2768,18 +2733,6 @@ interface Category {
      * + Default: `false`.
      */
     visible?: boolean | null;
-    /**
-     * Category breadcrumbs.
-     *
-     * > **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-03
-     */
-    breadcrumbs?: BreadcrumbItemValues;
     /**
      * Category breadcrumbs.
      *
@@ -2817,21 +2770,6 @@ interface Category {
      */
     extendedFields?: ExtendedFields;
 }
-interface BreadcrumbItemValues {
-    /**
-     * List of breadcrumb data. The current category isn't included in the list.
-     * @readonly
-     */
-    values?: BreadcrumbItem[];
-}
-interface BreadcrumbItem {
-    /** Category ID. */
-    categoryId?: string;
-    /** Category name. */
-    categoryName?: string;
-    /** Category slug. */
-    categorySlug?: string;
-}
 interface BreadcrumbsInfo {
     /**
      * List of breadcrumb data. The current category isn't included in the list.
@@ -4169,8 +4107,9 @@ interface QueryCategoriesRequest {
     /** Category tree reference details. */
     treeReference: TreeReference;
     /**
-     * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
-     * Used only in the first request. Following requests use the cursor token.
+     * Whether to return non-visible categories.
+     *
+     * Default: `false` (only visible categories are returned)
      */
     returnNonVisibleCategories?: boolean;
     /** Fields to include in the response. */
@@ -4226,7 +4165,7 @@ declare enum RequestedFields {
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
 interface QueryCategoriesResponse {
-    /** Categories which satisfy the provided query. */
+    /** List of categories. */
     categories?: Category[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
@@ -4975,14 +4914,6 @@ interface GetArrangedItemsResponse {
     /** List of arranged items. */
     items?: ItemReference[];
 }
-interface BreadcrumbItemNonNullableFields {
-    categoryId: string;
-    categoryName: string;
-    categorySlug: string;
-}
-interface BreadcrumbItemValuesNonNullableFields {
-    values: BreadcrumbItemNonNullableFields[];
-}
 interface BreadcrumbNonNullableFields {
     categoryId: string;
     categoryName: string;
@@ -5259,7 +5190,6 @@ interface CategoryNonNullableFields {
     image: string;
     itemCounter: number;
     totalItemCounter: number;
-    breadcrumbs?: BreadcrumbItemValuesNonNullableFields;
     breadcrumbsInfo?: BreadcrumbsInfoNonNullableFields;
     seoData?: SeoSchemaNonNullableFields;
     richContentDescription?: RichContentNonNullableFields;