@wix/categories 1.0.38 → 1.0.40

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

@@ -35,7 +35,10 @@ interface Category$1 {
      * @readonly
      */
     itemCounter?: number;
-    /** Category description. */
+    /**
+     * Category description.
+     * > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
+     */
     description?: string | null;
     /**
      * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
@@ -61,6 +64,7 @@ interface Category$1 {
     /**
      * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
      * In order to use this field you have to integrate with "Ricos" on frontend side. To learn how to do it visit https://ricos.js.org/.
+     * > **Note:** This field is returned only when you pass `fields: "RICH_CONTENT_DESCRIPTION"` in the request.
      */
     richContentDescription?: RichContent$1;
     /**
@@ -1360,11 +1364,13 @@ interface CreateCategoryRequest$1 {
     /** A reference to the tree that contains this category. */
     treeReference: TreeReference$1;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields$1[];
+    fields?: SingleEntityOpsRequestedFields$1[];
 }
-declare enum RequestedFields$1 {
+declare enum SingleEntityOpsRequestedFields$1 {
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
-    BREADCRUMBS = "BREADCRUMBS"
+    BREADCRUMBS = "BREADCRUMBS",
+    DESCRIPTION = "DESCRIPTION",
+    RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
 }
 interface CreateCategoryResponse$1 {
     /** The created Category. */
@@ -1376,7 +1382,7 @@ interface GetCategoryRequest$1 {
     /** A reference to the tree that contains this category. */
     treeReference: TreeReference$1;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields$1[];
+    fields?: SingleEntityOpsRequestedFields$1[];
 }
 interface GetCategoryResponse$1 {
     /** The retrieved Category. */
@@ -1388,7 +1394,7 @@ interface UpdateCategoryRequest$1 {
     /** A reference to the tree that contains this category. */
     treeReference: TreeReference$1;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields$1[];
+    fields?: SingleEntityOpsRequestedFields$1[];
 }
 interface UpdateCategoryResponse$1 {
     /** The updated Category. */
@@ -1423,6 +1429,10 @@ interface CursorPaging$1 {
      */
     cursor?: string | null;
 }
+declare enum RequestedFields$1 {
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    BREADCRUMBS = "BREADCRUMBS"
+}
 interface SearchCategoriesRequest$1 {
     /** WQL query expression. */
     search?: CursorSearch$1;
@@ -1967,7 +1977,7 @@ interface UpdateCategoryVisibilityRequest$1 {
     /** Latest revision of the category. */
     revision: string | null;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields$1[];
+    fields?: SingleEntityOpsRequestedFields$1[];
 }
 interface UpdateCategoryVisibilityResponse$1 {
     /** The updated Category. */
@@ -2598,7 +2608,10 @@ interface Category {
      * @readonly
      */
     itemCounter?: number;
-    /** Category description. */
+    /**
+     * Category description.
+     * > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
+     */
     description?: string | null;
     /**
      * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
@@ -2624,6 +2637,7 @@ interface Category {
     /**
      * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
      * In order to use this field you have to integrate with "Ricos" on frontend side. To learn how to do it visit https://ricos.js.org/.
+     * > **Note:** This field is returned only when you pass `fields: "RICH_CONTENT_DESCRIPTION"` in the request.
      */
     richContentDescription?: RichContent;
     /**
@@ -3900,11 +3914,13 @@ interface CreateCategoryRequest {
     /** A reference to the tree that contains this category. */
     treeReference: TreeReference;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields[];
+    fields?: SingleEntityOpsRequestedFields[];
 }
-declare enum RequestedFields {
+declare enum SingleEntityOpsRequestedFields {
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
-    BREADCRUMBS = "BREADCRUMBS"
+    BREADCRUMBS = "BREADCRUMBS",
+    DESCRIPTION = "DESCRIPTION",
+    RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
 }
 interface CreateCategoryResponse {
     /** The created Category. */
@@ -3916,7 +3932,7 @@ interface GetCategoryRequest {
     /** A reference to the tree that contains this category. */
     treeReference: TreeReference;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields[];
+    fields?: SingleEntityOpsRequestedFields[];
 }
 interface GetCategoryResponse {
     /** The retrieved Category. */
@@ -3928,7 +3944,7 @@ interface UpdateCategoryRequest {
     /** A reference to the tree that contains this category. */
     treeReference: TreeReference;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields[];
+    fields?: SingleEntityOpsRequestedFields[];
 }
 interface UpdateCategoryResponse {
     /** The updated Category. */
@@ -3963,6 +3979,10 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
+declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    BREADCRUMBS = "BREADCRUMBS"
+}
 interface SearchCategoriesRequest {
     /** WQL query expression. */
     search?: CursorSearch;
@@ -4507,7 +4527,7 @@ interface UpdateCategoryVisibilityRequest {
     /** Latest revision of the category. */
     revision: string | null;
     /** Fields to return in the response. When not provided, these fields are not returned. */
-    fields?: RequestedFields[];
+    fields?: SingleEntityOpsRequestedFields[];
 }
 interface UpdateCategoryVisibilityResponse {
     /** The updated Category. */