@wix/categories 1.0.40 → 1.0.41

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.
@@ -1,23 +1,21 @@
1
- /**
2
- * A Category is the main entity of CategoriesService that can be created, customized and managed by the user.
3
- * Category can be organized into a hierarchical tree structure by assigning a parent category.
4
- * This structure can then be used to group similar items in order to make it easier for clients to find them.
5
- */
6
1
  interface Category {
7
2
  /** Category ID. */
8
3
  _id?: string | null;
9
4
  /**
10
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
5
+ * Revision number, which increments by 1 each time the category is updated.
6
+ * To prevent conflicting changes, the current revision must be passed when updating.
7
+ *
8
+ * Ignored when creating a category.
11
9
  * @readonly
12
10
  */
13
11
  revision?: string | null;
14
12
  /**
15
- * Represents the time this Category was created.
13
+ * Date and time the category was created.
16
14
  * @readonly
17
15
  */
18
16
  _createdDate?: Date;
19
17
  /**
20
- * Represents the time this Category was last updated.
18
+ * Date and time the category was updated.
21
19
  * @readonly
22
20
  */
23
21
  _updatedDate?: Date;
@@ -25,13 +23,13 @@ interface Category {
25
23
  name?: string | null;
26
24
  /**
27
25
  * Category image.
28
- * Pass existing media ID for image previously saved in Wix media manager.
29
- * Pass full image URL to upload an image to Wix media manager.
30
- * In case of full url the image will be updated eventually.
26
+ *
27
+ * + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
28
+ * + Pass full image URL to upload to Wix Media Manager.
31
29
  */
32
30
  image?: string;
33
31
  /**
34
- * Number of items in this category alone.
32
+ * Number of items in this category.
35
33
  * @readonly
36
34
  */
37
35
  itemCounter?: number;
@@ -41,65 +39,72 @@ interface Category {
41
39
  */
42
40
  description?: string | null;
43
41
  /**
44
- * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
45
- * Even if visible is `false`, it can still be added manually to static page.
46
- * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.
47
- * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.
42
+ * Whether the category is visible to site visitors in dynamic pages.
43
+ *
44
+ * + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
45
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
46
+ * + Default: `false`.
48
47
  */
49
48
  visible?: boolean | null;
50
49
  /**
51
- * A category's breadcrumbs, Updated on moved to different parent or on renamed.
52
- * > **Note:** This field is returned only when you pass `fields: "BREADCRUMBS"` in the request.
50
+ * Category breadcrumbs.
51
+ *
52
+ * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
53
53
  * @readonly
54
54
  */
55
55
  breadcrumbs?: BreadcrumbItemValues;
56
- /** The parent category. */
56
+ /** Parent category reference data. */
57
57
  parentCategory?: ParentCategory;
58
58
  /**
59
- * A permanent, friendly URL name.
60
- * If not provided, on create generated automatically.
61
- * When provided, validated and must be unique.
59
+ * Category slug.
60
+ *
61
+ * If not provided, the slug is autogenerated based on the category name.
62
62
  */
63
63
  slug?: string | null;
64
64
  /**
65
- * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
66
- * 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/.
67
- * > **Note:** This field is returned only when you pass `fields: "RICH_CONTENT_DESCRIPTION"` in the request.
65
+ * Category description using rich content.
66
+ *
67
+ * Learn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).
68
+ * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
68
69
  */
69
70
  richContentDescription?: RichContent;
70
71
  /**
71
- * Optional - the ID of the app responsible for managing the items within this category.
72
- * If provided, the update of items assigned to this category and the deletion of it will be allowed only to the managing app.
73
- * The default is Empty.
72
+ * ID of the app responsible for managing the items in this category.
73
+ *
74
+ * Pass your app ID to restrict updating and deleting items in this category to your app only.
74
75
  */
75
76
  managingAppId?: string | null;
76
- /** Extensions enabling users to save custom data related to the category. */
77
+ /**
78
+ * Custom extended fields for the category object.
79
+ *
80
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.
81
+ */
77
82
  extendedFields?: ExtendedFields;
78
83
  }
79
- /** Wrapper for optional BreadcrumbItem values */
80
84
  interface BreadcrumbItemValues {
81
85
  /**
82
- * The wrapped BreadcrumbItem values
86
+ * List of breadcrumb data.
83
87
  * @readonly
84
88
  */
85
89
  values?: BreadcrumbItem[];
86
90
  }
87
91
  interface BreadcrumbItem {
88
- /** Represents the id of the category. */
92
+ /** Category ID. */
89
93
  categoryId?: string;
90
- /** Represents the name of the category. Translatable */
94
+ /** Category name. */
91
95
  categoryName?: string;
92
- /** Represents the slug. A permanent, friendly URL name of the category. */
96
+ /** Category slug. */
93
97
  categorySlug?: string;
94
98
  }
95
99
  interface ParentCategory {
96
100
  /**
97
- * Represents the id of the parent category.
98
- * If not passed, the default is the root category.
101
+ * Parent category ID.
102
+ *
103
+ * Default: root category ID
99
104
  */
100
105
  _id?: string | null;
101
106
  /**
102
- * Represents the index of current category within the parent category.
107
+ * Index position of the category within the parent category.
103
108
  * @readonly
104
109
  */
105
110
  index?: number | null;
@@ -1385,12 +1390,12 @@ interface TextNodeStyle {
1385
1390
  }
1386
1391
  interface TreeReference {
1387
1392
  /**
1388
- * The unique namespace of an app in dev-center that owns this tree.
1389
- * Should meet the format of @company/app1 where @company is an organizational unit and app1 is the app name.
1390
- * For example: @bookings/bookingslist, @achievements/quizzes
1393
+ * Namespace of the app that manages the tree.
1394
+ *
1395
+ * For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
1391
1396
  */
1392
1397
  appNamespace?: string;
1393
- /** Optional - The key of the tree. Must be provided when single app manages more than one tree. */
1398
+ /** Tree key. You must pass this when a single app manages more than one tree. */
1394
1399
  treeKey?: string | null;
1395
1400
  }
1396
1401
  interface ExtendedFields {
@@ -1461,12 +1466,84 @@ interface File {
1461
1466
  /** Invalidate by filename (for media files such as PDFs) */
1462
1467
  fileName?: string;
1463
1468
  }
1469
+ interface CategoryMoved {
1470
+ /** Category ID. */
1471
+ categoryId?: string;
1472
+ /** Parent category details. */
1473
+ parentCategory?: ParentCategory;
1474
+ /** Category tree reference details. */
1475
+ treeReference?: TreeReference;
1476
+ }
1477
+ interface ItemAddedToCategory {
1478
+ /** Category ID. */
1479
+ categoryId?: string;
1480
+ /** Details about the added item. */
1481
+ addedItem?: ItemReference;
1482
+ /** Category tree reference details. */
1483
+ treeReference?: TreeReference;
1484
+ }
1485
+ interface ItemReference {
1486
+ /**
1487
+ * ID of the item within the catalog it belongs to.
1488
+ *
1489
+ * For example, `product.id` for Wix Stores or `event.id` for Wix Events.
1490
+ */
1491
+ catalogItemId?: string;
1492
+ /**
1493
+ * ID of the app providing the catalog.
1494
+ *
1495
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
1496
+ *
1497
+ * For items from Wix catalogs, the following values always apply:
1498
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
1499
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
1500
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
1501
+ */
1502
+ appId?: string;
1503
+ }
1504
+ interface ItemsAddedToCategory {
1505
+ /** Category ID. */
1506
+ categoryId?: string;
1507
+ /** List of added items. */
1508
+ addedItems?: ItemReference[];
1509
+ /** Category tree reference details. */
1510
+ treeReference?: TreeReference;
1511
+ }
1512
+ interface ItemRemovedFromCategory {
1513
+ /** Category ID. */
1514
+ categoryId?: string;
1515
+ /** Details about the removed item. */
1516
+ removedItem?: ItemReference;
1517
+ /** Category tree reference details. */
1518
+ treeReference?: TreeReference;
1519
+ }
1520
+ interface ItemsRemovedFromCategory {
1521
+ /** Category ID. */
1522
+ categoryId?: string;
1523
+ /** List of removed items. */
1524
+ removedItems?: ItemReference[];
1525
+ /** Category tree reference details. */
1526
+ treeReference?: TreeReference;
1527
+ }
1528
+ interface ItemsArrangedInCategory {
1529
+ /** Category ID. */
1530
+ categoryId?: string;
1531
+ /** Category tree reference details. */
1532
+ treeReference?: TreeReference;
1533
+ }
1464
1534
  interface CreateCategoryRequest {
1465
- /** Category to be created. */
1535
+ /** Category to create. */
1466
1536
  category: Category;
1467
- /** A reference to the tree that contains this category. */
1537
+ /** Category tree reference details. */
1468
1538
  treeReference: TreeReference;
1469
- /** Fields to return in the response. When not provided, these fields are not returned. */
1539
+ /**
1540
+ * Fields to include in the response.
1541
+ *
1542
+ * Supported values:
1543
+ * + `BREADCRUMBS`
1544
+ * + `DESCRIPTION`
1545
+ * + `RICH_CONTENT_DESCRIPTION`
1546
+ */
1470
1547
  fields?: SingleEntityOpsRequestedFields[];
1471
1548
  }
1472
1549
  declare enum SingleEntityOpsRequestedFields {
@@ -1476,58 +1553,76 @@ declare enum SingleEntityOpsRequestedFields {
1476
1553
  RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
1477
1554
  }
1478
1555
  interface CreateCategoryResponse {
1479
- /** The created Category. */
1556
+ /** Created category. */
1480
1557
  category?: Category;
1481
1558
  }
1482
1559
  interface GetCategoryRequest {
1483
- /** Id of the Category to retrieve. */
1560
+ /** Category ID. */
1484
1561
  categoryId: string;
1485
- /** A reference to the tree that contains this category. */
1562
+ /** Category tree reference details. */
1486
1563
  treeReference: TreeReference;
1487
- /** Fields to return in the response. When not provided, these fields are not returned. */
1564
+ /**
1565
+ * Fields to include in the response.
1566
+ *
1567
+ * Supported values:
1568
+ * + `BREADCRUMBS`
1569
+ * + `DESCRIPTION`
1570
+ * + `RICH_CONTENT_DESCRIPTION`
1571
+ */
1488
1572
  fields?: SingleEntityOpsRequestedFields[];
1489
1573
  }
1490
1574
  interface GetCategoryResponse {
1491
- /** The retrieved Category. */
1575
+ /** Category. */
1492
1576
  category?: Category;
1493
1577
  }
1494
1578
  interface UpdateCategoryRequest {
1495
- /** Category to be updated, may be partial. */
1579
+ /** Category to update. */
1496
1580
  category: Category;
1497
- /** A reference to the tree that contains this category. */
1581
+ /** Category tree reference details. */
1498
1582
  treeReference: TreeReference;
1499
- /** Fields to return in the response. When not provided, these fields are not returned. */
1583
+ /**
1584
+ * Fields to include in the response.
1585
+ *
1586
+ * Supported values:
1587
+ * + `BREADCRUMBS`
1588
+ * + `DESCRIPTION`
1589
+ * + `RICH_CONTENT_DESCRIPTION`
1590
+ */
1500
1591
  fields?: SingleEntityOpsRequestedFields[];
1501
1592
  }
1502
1593
  interface UpdateCategoryResponse {
1503
- /** The updated Category. */
1594
+ /** Updated category. */
1504
1595
  category?: Category;
1505
1596
  }
1506
1597
  interface DeleteCategoryRequest {
1507
- /** Id of the Category to delete. */
1598
+ /** Category ID. */
1508
1599
  categoryId: string;
1509
- /** A reference to the tree that contains this category. */
1600
+ /** Category tree reference details. */
1510
1601
  treeReference: TreeReference;
1511
1602
  }
1512
1603
  interface DeleteCategoryResponse {
1513
1604
  }
1514
1605
  interface QueryCategoriesRequest {
1515
- /** WQL query expression. */
1516
- query?: QueryV2;
1517
- /**
1518
- * A reference to the tree that contains this category.
1519
- * Used only in the first request. Following requests use the cursor token.
1520
- */
1521
- treeReference?: TreeReference;
1606
+ /** Query options. */
1607
+ query?: CursorQuery;
1608
+ /** Category tree reference details. */
1609
+ treeReference: TreeReference;
1522
1610
  /**
1523
1611
  * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
1524
1612
  * Used only in the first request. Following requests use the cursor token.
1525
1613
  */
1526
1614
  returnNonVisibleCategories?: boolean;
1527
- /** Fields to return in the response. When not provided, these fields are not returned. */
1615
+ /**
1616
+ * Fields to include in the response.
1617
+ *
1618
+ * Supported values:
1619
+ * + `BREADCRUMBS`
1620
+ * + `DESCRIPTION`
1621
+ * + `RICH_CONTENT_DESCRIPTION`
1622
+ */
1528
1623
  fields?: RequestedFields[];
1529
1624
  }
1530
- interface QueryV2 extends QueryV2PagingMethodOneOf {
1625
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1531
1626
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1532
1627
  cursorPaging?: CursorPaging;
1533
1628
  /**
@@ -1546,7 +1641,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
1546
1641
  sort?: Sorting[];
1547
1642
  }
1548
1643
  /** @oneof */
1549
- interface QueryV2PagingMethodOneOf {
1644
+ interface CursorQueryPagingMethodOneOf {
1550
1645
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1551
1646
  cursorPaging?: CursorPaging;
1552
1647
  }
@@ -1560,12 +1655,6 @@ declare enum SortOrder {
1560
1655
  ASC = "ASC",
1561
1656
  DESC = "DESC"
1562
1657
  }
1563
- interface Paging {
1564
- /** Number of items to load. */
1565
- limit?: number | null;
1566
- /** Number of items to skip in the current sort order. */
1567
- offset?: number | null;
1568
- }
1569
1658
  interface CursorPaging {
1570
1659
  /** Maximum number of items to return in the results. */
1571
1660
  limit?: number | null;
@@ -1616,19 +1705,27 @@ interface CompactCategory {
1616
1705
  name?: string | null;
1617
1706
  }
1618
1707
  interface SearchCategoriesRequest {
1619
- /** WQL query expression. */
1708
+ /** Search options. */
1620
1709
  search?: CursorSearch;
1621
1710
  /**
1622
- * A reference to the tree that contains this category.
1623
- * Used only in the first request. Following requests use the cursor token.
1711
+ * Category tree reference details.
1712
+ * > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
1624
1713
  */
1625
1714
  treeReference: TreeReference;
1626
1715
  /**
1627
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
1628
- * Used only in the first request. Following requests use the cursor token.
1716
+ * Whether to return the categories with `visible: false`.
1717
+ *
1718
+ * Default: `false` - only visible categories are returned in the response
1629
1719
  */
1630
1720
  returnNonVisibleCategories?: boolean;
1631
- /** Fields to return in the response. When not provided, these fields are not returned. */
1721
+ /**
1722
+ * Fields to include in the response.
1723
+ *
1724
+ * Supported values:
1725
+ * + `BREADCRUMBS`
1726
+ * + `DESCRIPTION`
1727
+ * + `RICH_CONTENT_DESCRIPTION`
1728
+ */
1632
1729
  fields?: RequestedFields[];
1633
1730
  }
1634
1731
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -1839,13 +1936,23 @@ interface NestedAggregation {
1839
1936
  nestedAggregations?: NestedAggregationItem[];
1840
1937
  }
1841
1938
  interface SearchDetails {
1842
- /** Defines how separate search terms in `expression` are combined */
1939
+ /**
1940
+ * Defines how separate search terms in `expression` are combined.
1941
+ *
1942
+ * Supported values:
1943
+ * + `OR` - Any of the search terms must be present
1944
+ * + `AND` - All search terms must be present
1945
+ */
1843
1946
  mode?: Mode;
1844
- /** Search term or expression */
1947
+ /** Search term or expression. */
1845
1948
  expression?: string | null;
1846
- /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
1949
+ /**
1950
+ * Fields in which to search for the `expression`. Use dot notation to specify field path.
1951
+ *
1952
+ * When empty - all searchable fields are looked at.
1953
+ */
1847
1954
  fields?: string[];
1848
- /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
1955
+ /** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
1849
1956
  fuzzy?: boolean;
1850
1957
  }
1851
1958
  declare enum Mode {
@@ -1855,9 +1962,9 @@ declare enum Mode {
1855
1962
  AND = "AND"
1856
1963
  }
1857
1964
  interface SearchCategoriesResponse {
1858
- /** Categories which satisfy the provided query. */
1965
+ /** List of categories. */
1859
1966
  categories?: Category[];
1860
- /** Paging metadata. Contains cursor which can be used in next query. */
1967
+ /** Paging metadata. */
1861
1968
  pagingMetadata?: CursorPagingMetadata;
1862
1969
  /** Aggregation data. */
1863
1970
  aggregationData?: AggregationData;
@@ -2045,11 +2152,18 @@ interface AggregationResultsResultOneOf {
2045
2152
  interface DeprecatedSearchCategoriesWithOffsetRequest {
2046
2153
  /** WQL query expression. */
2047
2154
  search?: OffsetSearch;
2048
- /** A reference to the tree that contains this category. */
2155
+ /** Category tree reference details. */
2049
2156
  treeReference?: TreeReference;
2050
2157
  /** Whether to return categories with `visible:false`. Default: false so only visible categories will be in response. */
2051
2158
  returnNonVisibleCategories?: boolean;
2052
- /** Fields to return in the response. When not provided, these fields are not returned. */
2159
+ /**
2160
+ * Fields to include in the response.
2161
+ *
2162
+ * Supported values:
2163
+ * + `BREADCRUMBS`
2164
+ * + `DESCRIPTION`
2165
+ * + `RICH_CONTENT_DESCRIPTION`
2166
+ */
2053
2167
  fields?: RequestedFields[];
2054
2168
  }
2055
2169
  interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
@@ -2079,6 +2193,12 @@ interface OffsetSearchPagingMethodOneOf {
2079
2193
  /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
2080
2194
  paging?: Paging;
2081
2195
  }
2196
+ interface Paging {
2197
+ /** Number of items to load. */
2198
+ limit?: number | null;
2199
+ /** Number of items to skip in the current sort order. */
2200
+ offset?: number | null;
2201
+ }
2082
2202
  interface DeprecatedSearchCategoriesWithOffsetResponse {
2083
2203
  /** Categories which satisfy the provided query. */
2084
2204
  categories?: Category[];
@@ -2099,75 +2219,79 @@ interface PagingMetadata {
2099
2219
  }
2100
2220
  interface CountCategoriesRequest {
2101
2221
  /**
2102
- * A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
2103
- * To understand supported filters and limitations see `SearchCategories` method.
2222
+ * Filter object.
2223
+ *
2224
+ * Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2104
2225
  */
2105
2226
  filter?: Record<string, any> | null;
2106
- /** free text to match in searchable fields */
2227
+ /** Search options. */
2107
2228
  search?: SearchDetails;
2108
- /**
2109
- * A reference to the tree that contains this category.
2110
- * Used only in the first request. Following requests use the cursor token.
2111
- */
2229
+ /** Category tree reference details. */
2112
2230
  treeReference: TreeReference;
2113
2231
  /**
2114
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
2115
- * Used only in the first request. Following requests use the cursor token.
2232
+ * Whether to return categories with `visible: false` (hidden categories).
2233
+ *
2234
+ * Default: `false` - only visible categories are returned in the response
2116
2235
  */
2117
2236
  returnNonVisibleCategories?: boolean;
2118
2237
  }
2119
2238
  interface CountCategoriesResponse {
2120
- /** Total count of categories which satisfy the provided request. */
2239
+ /** Total count of categories which satisfy the given filter and/or search. */
2121
2240
  count?: number;
2122
2241
  }
2123
2242
  interface MoveCategoryRequest {
2124
- /** ID of category to place. */
2243
+ /** ID of the category to move. */
2125
2244
  categoryId: string;
2126
- /** A reference to the tree that contains this category. */
2245
+ /** Category tree reference details. */
2127
2246
  treeReference: TreeReference;
2128
2247
  /**
2129
- * ID of parent category.
2130
- * Optional. When not passed it will fallback to the root category
2248
+ * Parent category ID.
2249
+ *
2250
+ * Default: root category ID
2131
2251
  */
2132
2252
  parentCategoryId?: string | null;
2133
2253
  /**
2134
2254
  * Where to place the subcategory.
2135
- * `FIRST` - make category with `category_id` first subcategory with manual arrangement.
2136
- * `LAST` - make category with `category_id` last subcategory with manual arrangement.
2137
- * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.
2255
+ *
2256
+ * + `FIRST`: Position the category as the first subcategory.
2257
+ * + `LAST`: Position the category as the last subcategory.
2258
+ * + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
2138
2259
  */
2139
2260
  position: Position;
2140
- /** Required when `position` is `BEFORE`. Otherwise ignored */
2141
- moveBeforeCategoryId?: string | null;
2261
+ /** Required when passing `position: AFTER`. */
2262
+ moveAfterCategoryId?: string | null;
2142
2263
  }
2143
2264
  declare enum Position {
2144
2265
  UNKNOWN_POSITION = "UNKNOWN_POSITION",
2145
2266
  FIRST = "FIRST",
2146
2267
  LAST = "LAST",
2147
- BEFORE = "BEFORE"
2268
+ AFTER = "AFTER"
2148
2269
  }
2149
2270
  interface MoveCategoryResponse {
2150
- /** ID of parent category. */
2271
+ /** Parent category ID. */
2151
2272
  parentCategoryId?: string | null;
2152
- /** Information about manually arranged categories after move. */
2273
+ /** List of category IDs in the new order of arrangement. */
2153
2274
  categoriesAfterMove?: string[];
2154
2275
  }
2155
- interface CategoryMoved {
2156
- /** Category ID. */
2157
- categoryId?: string;
2158
- /** ID of parent category and index. */
2159
- parentCategory?: ParentCategory;
2160
- /** A reference to the tree that contains this category. */
2161
- treeReference?: TreeReference;
2162
- }
2163
2276
  interface BulkCreateCategoriesRequest {
2164
2277
  /** List of categories to be created. */
2165
2278
  categories?: Category[];
2166
- /** A reference to the tree that contains the categories. */
2279
+ /** Category tree reference details. */
2167
2280
  treeReference?: TreeReference;
2168
- /** Whether to return the category entity in the response. */
2281
+ /**
2282
+ * Whether to return the category entity in the response.
2283
+ *
2284
+ * Default: `false`
2285
+ */
2169
2286
  returnEntity?: boolean;
2170
- /** Fields to return in the response. When not provided, these fields are not returned. */
2287
+ /**
2288
+ * Fields to include in the response.
2289
+ *
2290
+ * Supported values:
2291
+ * + `BREADCRUMBS`
2292
+ * + `DESCRIPTION`
2293
+ * + `RICH_CONTENT_DESCRIPTION`
2294
+ */
2171
2295
  fields?: RequestedFields[];
2172
2296
  }
2173
2297
  interface BulkCreateCategoriesResponse {
@@ -2177,9 +2301,13 @@ interface BulkCreateCategoriesResponse {
2177
2301
  bulkActionMetadata?: BulkActionMetadata;
2178
2302
  }
2179
2303
  interface BulkCategoriesResult {
2180
- /** Information about successful action or error for failure. */
2304
+ /** Bulk action metadata for category. */
2181
2305
  itemMetadata?: ItemMetadata;
2182
- /** Created or updated category. Optional - returned only if requested with `return_entity` set to `true`. */
2306
+ /**
2307
+ * Full category entity.
2308
+ *
2309
+ * Returned only if `returnEntity: true` is passed in the request.
2310
+ */
2183
2311
  category?: Category;
2184
2312
  }
2185
2313
  interface ItemMetadata {
@@ -2209,17 +2337,28 @@ interface BulkActionMetadata {
2209
2337
  undetailedFailures?: number;
2210
2338
  }
2211
2339
  interface BulkUpdateCategoriesRequest {
2212
- /** List of categories to be updated. */
2340
+ /** List of categories to update. */
2213
2341
  categories: MaskedCategory[];
2214
- /** A reference to the tree that contains the categories. */
2342
+ /** Category tree reference details. */
2215
2343
  treeReference: TreeReference;
2216
- /** Whether to return the category entity in the response. */
2344
+ /**
2345
+ * Whether to return the full category entity in the response.
2346
+ *
2347
+ * Default: `false`
2348
+ */
2217
2349
  returnEntity?: boolean;
2218
- /** Fields to return in the response. When not provided, these fields are not returned. */
2350
+ /**
2351
+ * Fields to include in the response.
2352
+ *
2353
+ * Supported values:
2354
+ * + `BREADCRUMBS`
2355
+ * + `DESCRIPTION`
2356
+ * + `RICH_CONTENT_DESCRIPTION`
2357
+ */
2219
2358
  fields?: RequestedFields[];
2220
2359
  }
2221
2360
  interface MaskedCategory {
2222
- /** Category to be updated, may be partial. */
2361
+ /** Category to update. */
2223
2362
  category?: Category;
2224
2363
  }
2225
2364
  interface BulkUpdateCategoriesResponse {
@@ -2229,31 +2368,57 @@ interface BulkUpdateCategoriesResponse {
2229
2368
  bulkActionMetadata?: BulkActionMetadata;
2230
2369
  }
2231
2370
  interface UpdateCategoryVisibilityRequest {
2232
- /** ID of category to be updated */
2371
+ /** Category ID. */
2233
2372
  categoryId: string;
2234
- /** value to set `visible` to */
2373
+ /**
2374
+ * Whether the category is visible to site visitors in dynamic pages.
2375
+ *
2376
+ * + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
2377
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
2378
+ */
2235
2379
  visible: boolean;
2236
- /** A reference to the tree that contains this category. */
2380
+ /** Category tree reference details. */
2237
2381
  treeReference: TreeReference;
2238
- /** Latest revision of the category. */
2382
+ /**
2383
+ * Latest revision of the category.
2384
+ * To prevent conflicting changes, the current revision must be passed on update.
2385
+ */
2239
2386
  revision: string | null;
2240
- /** Fields to return in the response. When not provided, these fields are not returned. */
2387
+ /**
2388
+ * Fields to include in the response.
2389
+ *
2390
+ * Supported values:
2391
+ * + `BREADCRUMBS`
2392
+ * + `DESCRIPTION`
2393
+ * + `RICH_CONTENT_DESCRIPTION`
2394
+ */
2241
2395
  fields?: SingleEntityOpsRequestedFields[];
2242
2396
  }
2243
2397
  interface UpdateCategoryVisibilityResponse {
2244
- /** The updated Category. */
2398
+ /** Updated category. */
2245
2399
  category?: Category;
2246
2400
  }
2247
2401
  interface BulkUpdateCategoryVisibilityRequest {
2248
- /** IDs of categories to be updated. */
2402
+ /** IDs of the categories to update. */
2249
2403
  categoryIds?: string[];
2250
2404
  /** value to set `visible` to. This value will be set for all categories in the request */
2251
2405
  visible?: boolean;
2252
- /** A reference to the tree that contains this category. */
2406
+ /** Category tree reference details. */
2253
2407
  treeReference?: TreeReference;
2254
- /** Whether to return the category entity in the response. */
2408
+ /**
2409
+ * Whether to return the category entity in the response.
2410
+ *
2411
+ * Default: `false`
2412
+ */
2255
2413
  returnEntity?: boolean;
2256
- /** Fields to return in the response. When not provided, these fields are not returned. */
2414
+ /**
2415
+ * Fields to include in the response.
2416
+ *
2417
+ * Supported values:
2418
+ * + `BREADCRUMBS`
2419
+ * + `DESCRIPTION`
2420
+ * + `RICH_CONTENT_DESCRIPTION`
2421
+ */
2257
2422
  fields?: RequestedFields[];
2258
2423
  }
2259
2424
  interface BulkUpdateCategoryVisibilityResponse {
@@ -2272,13 +2437,17 @@ interface BulkUpdateCategoryVisibilityByFilterRequest {
2272
2437
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2273
2438
  */
2274
2439
  filter?: Record<string, any> | null;
2275
- /** A reference to the tree that contains the categories. */
2440
+ /** Category tree reference details. */
2276
2441
  treeReference?: TreeReference;
2277
2442
  /** value to set `visible` to. This value will be set for all categories that match the filter */
2278
2443
  visible?: boolean;
2279
2444
  }
2280
2445
  interface BulkUpdateCategoryVisibilityByFilterResponse {
2281
- /** Token that can be used to query "AsyncJobService" */
2446
+ /**
2447
+ * Job ID.
2448
+ *
2449
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
2450
+ */
2282
2451
  jobId?: string;
2283
2452
  }
2284
2453
  interface BulkDeleteCategoriesRequest {
@@ -2305,69 +2474,54 @@ interface BulkDeleteCategoriesByFilterRequest {
2305
2474
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2306
2475
  */
2307
2476
  filter?: Record<string, any> | null;
2308
- /** A reference to the tree that contains the categories. */
2477
+ /** Category tree reference details. */
2309
2478
  treeReference?: TreeReference;
2310
2479
  }
2311
2480
  interface BulkDeleteCategoriesByFilterResponse {
2312
- /** Token that can be used to query "AsyncJobService" */
2481
+ /**
2482
+ * Job ID.
2483
+ *
2484
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
2485
+ */
2313
2486
  jobId?: string;
2314
2487
  }
2315
2488
  interface BulkAddItemsToCategoryRequest {
2316
- /** Category id. */
2489
+ /** Category ID. */
2317
2490
  categoryId: string;
2318
- /** List of catalog items with reference info. */
2491
+ /** List of items to add. */
2319
2492
  items: ItemReference[];
2320
- /** A reference to the tree that contains this category. */
2493
+ /** Category tree reference details. */
2321
2494
  treeReference: TreeReference;
2322
2495
  }
2323
- interface ItemReference {
2324
- /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */
2325
- catalogItemId?: string;
2326
- /** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */
2327
- appId?: string;
2328
- }
2329
2496
  interface BulkAddItemsToCategoryResponse {
2330
- /** Items added by bulk action. */
2497
+ /** List of items added to a category by bulk action. */
2331
2498
  results?: BulkItemsToCategoryResult[];
2332
2499
  /** Bulk action metadata. */
2333
2500
  bulkActionMetadata?: BulkActionMetadata;
2334
2501
  }
2335
2502
  interface BulkItemsToCategoryResult {
2336
- /** Information about items that were added successfully and errors for failed items. */
2503
+ /** Bulk action metadata for category. */
2337
2504
  itemMetadata?: ItemReferenceMetadata;
2338
2505
  }
2339
2506
  interface ItemReferenceMetadata {
2340
- /** Item reference from request. */
2507
+ /** Catalog and item reference info. */
2341
2508
  item?: ItemReference;
2342
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2509
+ /** Original index of the item within the request array. Allows for correlation between request and response items. */
2343
2510
  originalIndex?: number;
2344
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2511
+ /**
2512
+ * Whether the action was successful.
2513
+ * When `false`, the `error` field is populated.
2514
+ */
2345
2515
  success?: boolean;
2346
- /** Details about the error in case of failure. */
2516
+ /** Error details in the case of an unsuccessful action. */
2347
2517
  error?: ApplicationError;
2348
2518
  }
2349
- interface ItemAddedToCategory {
2350
- /** Category ID. */
2351
- categoryId?: string;
2352
- /** Catalog item reference info. */
2353
- addedItem?: ItemReference;
2354
- /** A reference to the tree that contains this category. */
2355
- treeReference?: TreeReference;
2356
- }
2357
- interface ItemsAddedToCategory {
2358
- /** Category ID. */
2359
- categoryId?: string;
2360
- /** List of catalog items with reference info. */
2361
- addedItems?: ItemReference[];
2362
- /** A reference to the tree that contains this category. */
2363
- treeReference?: TreeReference;
2364
- }
2365
2519
  interface BulkAddItemToCategoriesRequest {
2366
- /** Catalog item reference info */
2520
+ /** Item to add. */
2367
2521
  item: ItemReference;
2368
- /** Category ids. */
2522
+ /** IDs of categories to which to add the item. */
2369
2523
  categoryIds: string[];
2370
- /** A reference to the tree that contains the categories. */
2524
+ /** Category tree reference details. */
2371
2525
  treeReference: TreeReference;
2372
2526
  }
2373
2527
  interface BulkAddItemToCategoriesResponse {
@@ -2377,15 +2531,15 @@ interface BulkAddItemToCategoriesResponse {
2377
2531
  bulkActionMetadata?: BulkActionMetadata;
2378
2532
  }
2379
2533
  interface BulkItemToCategoriesResult {
2380
- /** Information about categories to which item was added successfully and errors for failed items. `id` is ID of category. */
2534
+ /** Bulk action metadata for category. */
2381
2535
  itemMetadata?: ItemMetadata;
2382
2536
  }
2383
2537
  interface BulkRemoveItemsFromCategoryRequest {
2384
- /** Category id */
2538
+ /** Category ID. */
2385
2539
  categoryId: string;
2386
- /** List of catalog items with reference info. */
2540
+ /** List of items to remove. */
2387
2541
  items: ItemReference[];
2388
- /** A reference to the tree that contains this category. */
2542
+ /** Category tree reference details. */
2389
2543
  treeReference: TreeReference;
2390
2544
  }
2391
2545
  interface BulkRemoveItemsFromCategoryResponse {
@@ -2394,28 +2548,12 @@ interface BulkRemoveItemsFromCategoryResponse {
2394
2548
  /** Bulk action metadata. */
2395
2549
  bulkActionMetadata?: BulkActionMetadata;
2396
2550
  }
2397
- interface ItemRemovedFromCategory {
2398
- /** Category ID. */
2399
- categoryId?: string;
2400
- /** Catalog item reference info. */
2401
- removedItem?: ItemReference;
2402
- /** A reference to the tree that contains this category. */
2403
- treeReference?: TreeReference;
2404
- }
2405
- interface ItemsRemovedFromCategory {
2406
- /** Category ID. */
2407
- categoryId?: string;
2408
- /** List of catalog items with reference info. */
2409
- removedItems?: ItemReference[];
2410
- /** A reference to the tree that contains this category. */
2411
- treeReference?: TreeReference;
2412
- }
2413
2551
  interface BulkRemoveItemFromCategoriesRequest {
2414
- /** Catalog item reference info */
2552
+ /** Item to remove. */
2415
2553
  item: ItemReference;
2416
- /** Category ids. */
2554
+ /** IDs of categories from which to remove the item. */
2417
2555
  categoryIds: string[];
2418
- /** A reference to the tree that contains the categories. */
2556
+ /** Category tree reference details. */
2419
2557
  treeReference: TreeReference;
2420
2558
  }
2421
2559
  interface BulkRemoveItemFromCategoriesResponse {
@@ -2425,26 +2563,42 @@ interface BulkRemoveItemFromCategoriesResponse {
2425
2563
  bulkActionMetadata?: BulkActionMetadata;
2426
2564
  }
2427
2565
  interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
2428
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
2566
+ /**
2567
+ * Cursor paging options.
2568
+ *
2569
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2570
+ */
2429
2571
  cursorPaging?: CursorPaging;
2430
- /** ID of category containing items. */
2572
+ /** Category ID. */
2431
2573
  categoryId: string;
2432
- /** A reference to the tree that contains this category. */
2574
+ /** Category tree reference details. */
2433
2575
  treeReference: TreeReference;
2434
- /** Default: `false`. When `true` items arranged by user will be return before all other items. */
2576
+ /**
2577
+ * Whether to use category arrangement for sorting items.
2578
+ *
2579
+ * Default: `false`
2580
+ */
2435
2581
  useCategoryArrangement?: boolean;
2436
- /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
2582
+ /**
2583
+ * Whether to include items from subcategories.
2584
+ *
2585
+ * Default: `false` (only direct items of the category will be returned)
2586
+ */
2437
2587
  includeItemsFromSubcategories?: boolean;
2438
2588
  }
2439
2589
  /** @oneof */
2440
2590
  interface ListItemsInCategoryRequestPagingMethodOneOf {
2441
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
2591
+ /**
2592
+ * Cursor paging options.
2593
+ *
2594
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2595
+ */
2442
2596
  cursorPaging?: CursorPaging;
2443
2597
  }
2444
2598
  interface ListItemsInCategoryResponse {
2445
- /** Items which satisfy query. */
2599
+ /** List of items in the category. */
2446
2600
  items?: ItemReference[];
2447
- /** Paging metadata. Contains cursor which can be used in next query. */
2601
+ /** Paging metadata. */
2448
2602
  pagingMetadata?: PagingMetadataV2;
2449
2603
  }
2450
2604
  interface PagingMetadataV2 {
@@ -2458,30 +2612,27 @@ interface PagingMetadataV2 {
2458
2612
  cursors?: Cursors;
2459
2613
  }
2460
2614
  interface ListCategoriesForItemRequest {
2461
- /** Catalog item reference info. */
2615
+ /** Item reference info. */
2462
2616
  item: ItemReference;
2463
- /** A reference to the tree that contains the categories. */
2617
+ /** Category tree reference details. */
2464
2618
  treeReference: TreeReference;
2465
2619
  }
2466
2620
  interface ListCategoriesForItemResponse {
2467
- /** A list of category IDs that contain this item directly. */
2621
+ /** List of IDs of categories that directly contain this item. */
2468
2622
  directCategoryIds?: string[];
2469
- /** A list of category IDs that contain this item directly and their parent category IDs. */
2623
+ /** List of IDs of categories that directly contain this item, and their parent category IDs. */
2470
2624
  allCategoryIds?: string[];
2471
2625
  }
2472
2626
  interface ListTreesRequest {
2473
2627
  }
2474
2628
  interface ListTreesResponse {
2475
- /** A list of all trees */
2629
+ /** List of trees. */
2476
2630
  trees?: TreeReference[];
2477
2631
  }
2478
2632
  interface MoveItemInCategoryRequest {
2479
- /**
2480
- * ID of category.
2481
- * Item must be direct child of this category, otherwise error returned
2482
- */
2633
+ /** Category ID. */
2483
2634
  categoryId?: string;
2484
- /** A reference to the tree that contains this category. */
2635
+ /** Category tree reference details. */
2485
2636
  treeReference?: TreeReference;
2486
2637
  /** Item to move. */
2487
2638
  item?: ItemReference;
@@ -2507,39 +2658,30 @@ interface MoveItemInCategoryResponse {
2507
2658
  /** Information about manually arranged items after move. */
2508
2659
  itemsAfterMove?: ItemReference[];
2509
2660
  }
2510
- interface ItemsArrangedInCategory {
2511
- /** Category ID. */
2512
- categoryId?: string;
2513
- /** A reference to the tree that contains this category. */
2514
- treeReference?: TreeReference;
2515
- }
2516
2661
  interface SetArrangedItemsRequest {
2517
- /** ID of category. */
2662
+ /** Category ID. */
2518
2663
  categoryId: string;
2519
- /** A reference to the tree that contains this category. */
2664
+ /** Category tree reference details. */
2520
2665
  treeReference: TreeReference;
2521
- /**
2522
- * List of arranged items to set.
2523
- * All items must be direct children of category with `category_id`, otherwise error returned.
2524
- */
2666
+ /** List of items to set. */
2525
2667
  items?: ItemReference[];
2526
2668
  }
2527
2669
  interface SetArrangedItemsResponse {
2528
- /** The updated list of arranged items in category. */
2670
+ /** List of arranged items. */
2529
2671
  items?: ItemReference[];
2530
2672
  }
2531
2673
  interface GetArrangedItemsRequest {
2532
- /** ID of category. */
2674
+ /** Category ID. */
2533
2675
  categoryId: string;
2534
- /** A reference to the tree that contains this category. */
2676
+ /** Category tree reference details. */
2535
2677
  treeReference: TreeReference;
2536
2678
  }
2537
2679
  interface GetArrangedItemsResponse {
2538
- /** List of arranged items in category. */
2680
+ /** List of arranged items. */
2539
2681
  items?: ItemReference[];
2540
2682
  }
2541
2683
  interface GetCategoriesTreeRequest {
2542
- /** A reference to the tree. */
2684
+ /** Category tree reference details. */
2543
2685
  treeReference?: TreeReference;
2544
2686
  }
2545
2687
  interface GetCategoriesTreeResponse {
@@ -2550,7 +2692,7 @@ interface GetCategoriesTreeResponse {
2550
2692
  interface CategoryTreeNode {
2551
2693
  /** Category ID. */
2552
2694
  _id?: Uint8Array;
2553
- /** A list of child categories. */
2695
+ /** List of subcategories. */
2554
2696
  subcategories?: CategoryTreeNode[];
2555
2697
  }
2556
2698
  interface DomainEvent extends DomainEventBodyOneOf {
@@ -2955,6 +3097,9 @@ interface GetCategoryResponseNonNullableFields {
2955
3097
  interface UpdateCategoryResponseNonNullableFields {
2956
3098
  category?: CategoryNonNullableFields;
2957
3099
  }
3100
+ interface QueryCategoriesResponseNonNullableFields {
3101
+ categories: CategoryNonNullableFields[];
3102
+ }
2958
3103
  interface ValueAggregationResultNonNullableFields {
2959
3104
  value: string;
2960
3105
  count: number;
@@ -3090,104 +3235,48 @@ interface SetArrangedItemsResponseNonNullableFields {
3090
3235
  interface GetArrangedItemsResponseNonNullableFields {
3091
3236
  items: ItemReferenceNonNullableFields[];
3092
3237
  }
3093
- interface BaseEventMetadata {
3094
- /** App instance ID. */
3095
- instanceId?: string | null;
3096
- /** Event type. */
3097
- eventType?: string;
3098
- /** The identification type and identity data. */
3099
- identity?: IdentificationData;
3100
- }
3101
- interface EventMetadata extends BaseEventMetadata {
3102
- /**
3103
- * Unique event ID.
3104
- * Allows clients to ignore duplicate webhooks.
3105
- */
3106
- _id?: string;
3107
- /**
3108
- * Assumes actions are also always typed to an entity_type
3109
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3110
- */
3111
- entityFqdn?: string;
3112
- /**
3113
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3114
- * This is although the created/updated/deleted notion is duplication of the oneof types
3115
- * Example: created/updated/deleted/started/completed/email_opened
3116
- */
3117
- slug?: string;
3118
- /** ID of the entity associated with the event. */
3119
- entityId?: string;
3120
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3121
- eventTime?: Date;
3122
- /**
3123
- * Whether the event was triggered as a result of a privacy regulation application
3124
- * (for example, GDPR).
3125
- */
3126
- triggeredByAnonymizeRequest?: boolean | null;
3127
- /** If present, indicates the action that triggered the event. */
3128
- originatedFrom?: string | null;
3129
- /**
3130
- * A sequence number defining the order of updates to the underlying entity.
3131
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
3132
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3133
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3134
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
3135
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3136
- */
3137
- entityEventSequence?: string | null;
3138
- }
3139
- interface CategoryCreatedEnvelope {
3140
- entity: Category;
3141
- metadata: EventMetadata;
3142
- }
3143
- interface CategoryUpdatedEnvelope {
3144
- entity: Category;
3145
- metadata: EventMetadata;
3146
- }
3147
- interface CategoryDeletedEnvelope {
3148
- metadata: EventMetadata;
3149
- }
3150
- interface CategoryMovedEnvelope {
3151
- data: CategoryMoved;
3152
- metadata: EventMetadata;
3153
- }
3154
- interface CategoryItemAddedToCategoryEnvelope {
3155
- data: ItemAddedToCategory;
3156
- metadata: EventMetadata;
3157
- }
3158
- interface CategoryItemRemovedFromCategoryEnvelope {
3159
- data: ItemRemovedFromCategory;
3160
- metadata: EventMetadata;
3161
- }
3162
- interface CategoryItemsArrangedInCategoryEnvelope {
3163
- data: ItemsArrangedInCategory;
3164
- metadata: EventMetadata;
3165
- }
3166
3238
  interface CreateCategoryOptions {
3167
- /** A reference to the tree that contains this category. */
3239
+ /** Category tree reference details. */
3168
3240
  treeReference: TreeReference;
3169
- /** Fields to return in the response. When not provided, these fields are not returned. */
3241
+ /**
3242
+ * Fields to include in the response.
3243
+ *
3244
+ * Supported values:
3245
+ * + `BREADCRUMBS`
3246
+ * + `DESCRIPTION`
3247
+ * + `RICH_CONTENT_DESCRIPTION`
3248
+ */
3170
3249
  fields?: SingleEntityOpsRequestedFields[];
3171
3250
  }
3172
3251
  interface GetCategoryOptions {
3173
- /** Fields to return in the response. When not provided, these fields are not returned. */
3252
+ /**
3253
+ * Fields to include in the response.
3254
+ *
3255
+ * Supported values:
3256
+ * + `BREADCRUMBS`
3257
+ * + `DESCRIPTION`
3258
+ * + `RICH_CONTENT_DESCRIPTION`
3259
+ */
3174
3260
  fields?: SingleEntityOpsRequestedFields[];
3175
3261
  }
3176
3262
  interface UpdateCategory {
3177
3263
  /** Category ID. */
3178
3264
  _id?: string | null;
3179
3265
  /**
3180
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
3266
+ * Revision number, which increments by 1 each time the category is updated.
3267
+ * To prevent conflicting changes, the current revision must be passed when updating.
3268
+ *
3269
+ * Ignored when creating a category.
3181
3270
  * @readonly
3182
3271
  */
3183
3272
  revision?: string | null;
3184
3273
  /**
3185
- * Represents the time this Category was created.
3274
+ * Date and time the category was created.
3186
3275
  * @readonly
3187
3276
  */
3188
3277
  _createdDate?: Date;
3189
3278
  /**
3190
- * Represents the time this Category was last updated.
3279
+ * Date and time the category was updated.
3191
3280
  * @readonly
3192
3281
  */
3193
3282
  _updatedDate?: Date;
@@ -3195,13 +3284,13 @@ interface UpdateCategory {
3195
3284
  name?: string | null;
3196
3285
  /**
3197
3286
  * Category image.
3198
- * Pass existing media ID for image previously saved in Wix media manager.
3199
- * Pass full image URL to upload an image to Wix media manager.
3200
- * In case of full url the image will be updated eventually.
3287
+ *
3288
+ * + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
3289
+ * + Pass full image URL to upload to Wix Media Manager.
3201
3290
  */
3202
3291
  image?: string;
3203
3292
  /**
3204
- * Number of items in this category alone.
3293
+ * Number of items in this category.
3205
3294
  * @readonly
3206
3295
  */
3207
3296
  itemCounter?: number;
@@ -3211,153 +3300,306 @@ interface UpdateCategory {
3211
3300
  */
3212
3301
  description?: string | null;
3213
3302
  /**
3214
- * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
3215
- * Even if visible is `false`, it can still be added manually to static page.
3216
- * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.
3217
- * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.
3303
+ * Whether the category is visible to site visitors in dynamic pages.
3304
+ *
3305
+ * + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
3306
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
3307
+ * + Default: `false`.
3218
3308
  */
3219
3309
  visible?: boolean | null;
3220
3310
  /**
3221
- * A category's breadcrumbs, Updated on moved to different parent or on renamed.
3222
- * > **Note:** This field is returned only when you pass `fields: "BREADCRUMBS"` in the request.
3311
+ * Category breadcrumbs.
3312
+ *
3313
+ * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
3223
3314
  * @readonly
3224
3315
  */
3225
3316
  breadcrumbs?: BreadcrumbItemValues;
3226
- /** The parent category. */
3317
+ /** Parent category reference data. */
3227
3318
  parentCategory?: ParentCategory;
3228
3319
  /**
3229
- * A permanent, friendly URL name.
3230
- * If not provided, on create generated automatically.
3231
- * When provided, validated and must be unique.
3320
+ * Category slug.
3321
+ *
3322
+ * If not provided, the slug is autogenerated based on the category name.
3232
3323
  */
3233
3324
  slug?: string | null;
3234
3325
  /**
3235
- * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
3236
- * 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/.
3237
- * > **Note:** This field is returned only when you pass `fields: "RICH_CONTENT_DESCRIPTION"` in the request.
3326
+ * Category description using rich content.
3327
+ *
3328
+ * Learn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).
3329
+ * > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
3238
3330
  */
3239
3331
  richContentDescription?: RichContent;
3240
3332
  /**
3241
- * Optional - the ID of the app responsible for managing the items within this category.
3242
- * If provided, the update of items assigned to this category and the deletion of it will be allowed only to the managing app.
3243
- * The default is Empty.
3333
+ * ID of the app responsible for managing the items in this category.
3334
+ *
3335
+ * Pass your app ID to restrict updating and deleting items in this category to your app only.
3244
3336
  */
3245
3337
  managingAppId?: string | null;
3246
- /** Extensions enabling users to save custom data related to the category. */
3338
+ /**
3339
+ * Custom extended fields for the category object.
3340
+ *
3341
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.
3342
+ */
3247
3343
  extendedFields?: ExtendedFields;
3248
3344
  }
3249
3345
  interface UpdateCategoryOptions {
3250
- /** A reference to the tree that contains this category. */
3346
+ /** Category tree reference details. */
3251
3347
  treeReference: TreeReference;
3252
- /** Fields to return in the response. When not provided, these fields are not returned. */
3348
+ /**
3349
+ * Fields to include in the response.
3350
+ *
3351
+ * Supported values:
3352
+ * + `BREADCRUMBS`
3353
+ * + `DESCRIPTION`
3354
+ * + `RICH_CONTENT_DESCRIPTION`
3355
+ */
3253
3356
  fields?: SingleEntityOpsRequestedFields[];
3254
3357
  }
3358
+ interface QueryCategoriesOptions {
3359
+ /** Category tree reference details. */
3360
+ treeReference: TreeReference;
3361
+ /**
3362
+ * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
3363
+ * Used only in the first request. Following requests use the cursor token.
3364
+ */
3365
+ returnNonVisibleCategories?: boolean | undefined;
3366
+ /**
3367
+ * Fields to include in the response.
3368
+ *
3369
+ * Supported values:
3370
+ * + `BREADCRUMBS`
3371
+ * + `DESCRIPTION`
3372
+ * + `RICH_CONTENT_DESCRIPTION`
3373
+ */
3374
+ fields?: RequestedFields[] | undefined;
3375
+ }
3376
+ interface QueryCursorResult {
3377
+ cursors: Cursors;
3378
+ hasNext: () => boolean;
3379
+ hasPrev: () => boolean;
3380
+ length: number;
3381
+ pageSize: number;
3382
+ }
3383
+ interface CategoriesQueryResult extends QueryCursorResult {
3384
+ items: Category[];
3385
+ query: CategoriesQueryBuilder;
3386
+ next: () => Promise<CategoriesQueryResult>;
3387
+ prev: () => Promise<CategoriesQueryResult>;
3388
+ }
3389
+ interface CategoriesQueryBuilder {
3390
+ /** @param propertyName - Property whose value is compared with `value`.
3391
+ * @param value - Value to compare against.
3392
+ * @documentationMaturity preview
3393
+ */
3394
+ eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3395
+ /** @param propertyName - Property whose value is compared with `value`.
3396
+ * @param value - Value to compare against.
3397
+ * @documentationMaturity preview
3398
+ */
3399
+ ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3400
+ /** @param propertyName - Property whose value is compared with `value`.
3401
+ * @param value - Value to compare against.
3402
+ * @documentationMaturity preview
3403
+ */
3404
+ ge: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3405
+ /** @param propertyName - Property whose value is compared with `value`.
3406
+ * @param value - Value to compare against.
3407
+ * @documentationMaturity preview
3408
+ */
3409
+ gt: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3410
+ /** @param propertyName - Property whose value is compared with `value`.
3411
+ * @param value - Value to compare against.
3412
+ * @documentationMaturity preview
3413
+ */
3414
+ le: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3415
+ /** @param propertyName - Property whose value is compared with `value`.
3416
+ * @param value - Value to compare against.
3417
+ * @documentationMaturity preview
3418
+ */
3419
+ lt: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3420
+ /** @param propertyName - Property whose value is compared with `string`.
3421
+ * @param string - String to compare against. Case-insensitive.
3422
+ * @documentationMaturity preview
3423
+ */
3424
+ startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: string) => CategoriesQueryBuilder;
3425
+ /** @param propertyName - Property whose value is compared with `values`.
3426
+ * @param values - List of values to compare against.
3427
+ * @documentationMaturity preview
3428
+ */
3429
+ hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
3430
+ /** @documentationMaturity preview */
3431
+ in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3432
+ /** @documentationMaturity preview */
3433
+ exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
3434
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3435
+ * @documentationMaturity preview
3436
+ */
3437
+ ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
3438
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3439
+ * @documentationMaturity preview
3440
+ */
3441
+ descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
3442
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
3443
+ * @documentationMaturity preview
3444
+ */
3445
+ limit: (limit: number) => CategoriesQueryBuilder;
3446
+ /** @param cursor - A pointer to specific record
3447
+ * @documentationMaturity preview
3448
+ */
3449
+ skipTo: (cursor: string) => CategoriesQueryBuilder;
3450
+ /** @documentationMaturity preview */
3451
+ find: () => Promise<CategoriesQueryResult>;
3452
+ }
3255
3453
  interface SearchCategoriesOptions {
3256
- /** WQL query expression. */
3454
+ /** Search options. */
3257
3455
  search?: CursorSearch;
3258
3456
  /**
3259
- * A reference to the tree that contains this category.
3260
- * Used only in the first request. Following requests use the cursor token.
3457
+ * Category tree reference details.
3458
+ * > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
3261
3459
  */
3262
3460
  treeReference: TreeReference;
3263
3461
  /**
3264
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
3265
- * Used only in the first request. Following requests use the cursor token.
3462
+ * Whether to return the categories with `visible: false`.
3463
+ *
3464
+ * Default: `false` - only visible categories are returned in the response
3266
3465
  */
3267
3466
  returnNonVisibleCategories?: boolean;
3268
- /** Fields to return in the response. When not provided, these fields are not returned. */
3467
+ /**
3468
+ * Fields to include in the response.
3469
+ *
3470
+ * Supported values:
3471
+ * + `BREADCRUMBS`
3472
+ * + `DESCRIPTION`
3473
+ * + `RICH_CONTENT_DESCRIPTION`
3474
+ */
3269
3475
  fields?: RequestedFields[];
3270
3476
  }
3271
3477
  interface CountCategoriesOptions {
3272
3478
  /**
3273
- * A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
3274
- * To understand supported filters and limitations see `SearchCategories` method.
3479
+ * Filter object.
3480
+ *
3481
+ * Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3275
3482
  */
3276
3483
  filter?: Record<string, any> | null;
3277
- /** free text to match in searchable fields */
3484
+ /** Search options. */
3278
3485
  search?: SearchDetails;
3279
- /**
3280
- * A reference to the tree that contains this category.
3281
- * Used only in the first request. Following requests use the cursor token.
3282
- */
3486
+ /** Category tree reference details. */
3283
3487
  treeReference: TreeReference;
3284
3488
  /**
3285
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
3286
- * Used only in the first request. Following requests use the cursor token.
3489
+ * Whether to return categories with `visible: false` (hidden categories).
3490
+ *
3491
+ * Default: `false` - only visible categories are returned in the response
3287
3492
  */
3288
3493
  returnNonVisibleCategories?: boolean;
3289
3494
  }
3290
3495
  interface MoveCategoryOptions {
3291
3496
  /**
3292
- * ID of parent category.
3293
- * Optional. When not passed it will fallback to the root category
3497
+ * Parent category ID.
3498
+ *
3499
+ * Default: root category ID
3294
3500
  */
3295
3501
  parentCategoryId?: string | null;
3296
3502
  /**
3297
3503
  * Where to place the subcategory.
3298
- * `FIRST` - make category with `category_id` first subcategory with manual arrangement.
3299
- * `LAST` - make category with `category_id` last subcategory with manual arrangement.
3300
- * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.
3504
+ *
3505
+ * + `FIRST`: Position the category as the first subcategory.
3506
+ * + `LAST`: Position the category as the last subcategory.
3507
+ * + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
3301
3508
  */
3302
3509
  position: Position;
3303
- /** Required when `position` is `BEFORE`. Otherwise ignored */
3304
- moveBeforeCategoryId?: string | null;
3510
+ /** Required when passing `position: AFTER`. */
3511
+ moveAfterCategoryId?: string | null;
3305
3512
  }
3306
3513
  interface BulkUpdateCategoriesOptions {
3307
- /** A reference to the tree that contains the categories. */
3514
+ /** Category tree reference details. */
3308
3515
  treeReference: TreeReference;
3309
- /** Whether to return the category entity in the response. */
3516
+ /**
3517
+ * Whether to return the full category entity in the response.
3518
+ *
3519
+ * Default: `false`
3520
+ */
3310
3521
  returnEntity?: boolean;
3311
- /** Fields to return in the response. When not provided, these fields are not returned. */
3522
+ /**
3523
+ * Fields to include in the response.
3524
+ *
3525
+ * Supported values:
3526
+ * + `BREADCRUMBS`
3527
+ * + `DESCRIPTION`
3528
+ * + `RICH_CONTENT_DESCRIPTION`
3529
+ */
3312
3530
  fields?: RequestedFields[];
3313
3531
  }
3314
3532
  interface UpdateCategoryVisibilityOptions {
3315
- /** value to set `visible` to */
3533
+ /**
3534
+ * Whether the category is visible to site visitors in dynamic pages.
3535
+ *
3536
+ * + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
3537
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
3538
+ */
3316
3539
  visible: boolean;
3317
- /** A reference to the tree that contains this category. */
3540
+ /** Category tree reference details. */
3318
3541
  treeReference: TreeReference;
3319
- /** Latest revision of the category. */
3542
+ /**
3543
+ * Latest revision of the category.
3544
+ * To prevent conflicting changes, the current revision must be passed on update.
3545
+ */
3320
3546
  revision: string | null;
3321
- /** Fields to return in the response. When not provided, these fields are not returned. */
3547
+ /**
3548
+ * Fields to include in the response.
3549
+ *
3550
+ * Supported values:
3551
+ * + `BREADCRUMBS`
3552
+ * + `DESCRIPTION`
3553
+ * + `RICH_CONTENT_DESCRIPTION`
3554
+ */
3322
3555
  fields?: SingleEntityOpsRequestedFields[];
3323
3556
  }
3324
3557
  interface BulkAddItemsToCategoryOptions {
3325
- /** A reference to the tree that contains this category. */
3558
+ /** Category tree reference details. */
3326
3559
  treeReference: TreeReference;
3327
3560
  }
3328
3561
  interface BulkAddItemToCategoriesOptions {
3329
- /** Category ids. */
3562
+ /** IDs of categories to which to add the item. */
3330
3563
  categoryIds: string[];
3331
- /** A reference to the tree that contains the categories. */
3564
+ /** Category tree reference details. */
3332
3565
  treeReference: TreeReference;
3333
3566
  }
3334
3567
  interface BulkRemoveItemsFromCategoryOptions {
3335
- /** A reference to the tree that contains this category. */
3568
+ /** Category tree reference details. */
3336
3569
  treeReference: TreeReference;
3337
3570
  }
3338
3571
  interface BulkRemoveItemFromCategoriesOptions {
3339
- /** Category ids. */
3572
+ /** IDs of categories from which to remove the item. */
3340
3573
  categoryIds: string[];
3341
- /** A reference to the tree that contains the categories. */
3574
+ /** Category tree reference details. */
3342
3575
  treeReference: TreeReference;
3343
3576
  }
3344
3577
  interface ListItemsInCategoryOptions extends ListItemsInCategoryRequestPagingMethodOneOf {
3345
- /** Default: `false`. When `true` items arranged by user will be return before all other items. */
3578
+ /**
3579
+ * Whether to use category arrangement for sorting items.
3580
+ *
3581
+ * Default: `false`
3582
+ */
3346
3583
  useCategoryArrangement?: boolean;
3347
- /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
3584
+ /**
3585
+ * Whether to include items from subcategories.
3586
+ *
3587
+ * Default: `false` (only direct items of the category will be returned)
3588
+ */
3348
3589
  includeItemsFromSubcategories?: boolean;
3349
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
3590
+ /**
3591
+ * Cursor paging options.
3592
+ *
3593
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3594
+ */
3350
3595
  cursorPaging?: CursorPaging;
3351
3596
  }
3352
3597
  interface ListCategoriesForItemOptions {
3353
- /** A reference to the tree that contains the categories. */
3598
+ /** Category tree reference details. */
3354
3599
  treeReference: TreeReference;
3355
3600
  }
3356
3601
  interface SetArrangedItemsOptions {
3357
- /**
3358
- * List of arranged items to set.
3359
- * All items must be direct children of category with `category_id`, otherwise error returned.
3360
- */
3602
+ /** List of items to set. */
3361
3603
  items?: ItemReference[];
3362
3604
  }
3363
3605
 
@@ -3387,16 +3629,6 @@ type APIMetadata = {
3387
3629
  packageName?: string;
3388
3630
  };
3389
3631
  type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
3390
- type EventDefinition<Payload = unknown, Type extends string = string> = {
3391
- __type: 'event-definition';
3392
- type: Type;
3393
- isDomainEvent?: boolean;
3394
- transformations?: (envelope: unknown) => Payload;
3395
- __payload: Payload;
3396
- };
3397
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
3398
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
3399
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
3400
3632
 
3401
3633
  declare global {
3402
3634
  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -3407,12 +3639,11 @@ declare global {
3407
3639
 
3408
3640
  declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
3409
3641
 
3410
- declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3411
-
3412
3642
  declare const createCategory: ReturnType<typeof createRESTModule<typeof publicCreateCategory>>;
3413
3643
  declare const getCategory: ReturnType<typeof createRESTModule<typeof publicGetCategory>>;
3414
3644
  declare const updateCategory: ReturnType<typeof createRESTModule<typeof publicUpdateCategory>>;
3415
3645
  declare const deleteCategory: ReturnType<typeof createRESTModule<typeof publicDeleteCategory>>;
3646
+ declare const queryCategories: ReturnType<typeof createRESTModule<typeof publicQueryCategories>>;
3416
3647
  declare const searchCategories: ReturnType<typeof createRESTModule<typeof publicSearchCategories>>;
3417
3648
  declare const countCategories: ReturnType<typeof createRESTModule<typeof publicCountCategories>>;
3418
3649
  declare const moveCategory: ReturnType<typeof createRESTModule<typeof publicMoveCategory>>;
@@ -3427,13 +3658,6 @@ declare const listCategoriesForItem: ReturnType<typeof createRESTModule<typeof p
3427
3658
  declare const listTrees: ReturnType<typeof createRESTModule<typeof publicListTrees>>;
3428
3659
  declare const setArrangedItems: ReturnType<typeof createRESTModule<typeof publicSetArrangedItems>>;
3429
3660
  declare const getArrangedItems: ReturnType<typeof createRESTModule<typeof publicGetArrangedItems>>;
3430
- declare const onCategoryCreated: ReturnType<typeof createEventModule<typeof publicOnCategoryCreated>>;
3431
- declare const onCategoryUpdated: ReturnType<typeof createEventModule<typeof publicOnCategoryUpdated>>;
3432
- declare const onCategoryDeleted: ReturnType<typeof createEventModule<typeof publicOnCategoryDeleted>>;
3433
- declare const onCategoryMoved: ReturnType<typeof createEventModule<typeof publicOnCategoryMoved>>;
3434
- declare const onCategoryItemAddedToCategory: ReturnType<typeof createEventModule<typeof publicOnCategoryItemAddedToCategory>>;
3435
- declare const onCategoryItemRemovedFromCategory: ReturnType<typeof createEventModule<typeof publicOnCategoryItemRemovedFromCategory>>;
3436
- declare const onCategoryItemsArrangedInCategory: ReturnType<typeof createEventModule<typeof publicOnCategoryItemsArrangedInCategory>>;
3437
3661
 
3438
3662
  type context_ActionEvent = ActionEvent;
3439
3663
  type context_Aggregation = Aggregation;
@@ -3458,7 +3682,6 @@ type context_Background = Background;
3458
3682
  type context_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;
3459
3683
  type context_BackgroundType = BackgroundType;
3460
3684
  declare const context_BackgroundType: typeof BackgroundType;
3461
- type context_BaseEventMetadata = BaseEventMetadata;
3462
3685
  type context_BlockquoteData = BlockquoteData;
3463
3686
  type context_BookingData = BookingData;
3464
3687
  type context_Border = Border;
@@ -3502,17 +3725,12 @@ type context_BulkUpdateCategoryVisibilityRequest = BulkUpdateCategoryVisibilityR
3502
3725
  type context_BulkUpdateCategoryVisibilityResponse = BulkUpdateCategoryVisibilityResponse;
3503
3726
  type context_BulletedListData = BulletedListData;
3504
3727
  type context_ButtonData = ButtonData;
3728
+ type context_CategoriesQueryBuilder = CategoriesQueryBuilder;
3729
+ type context_CategoriesQueryResult = CategoriesQueryResult;
3505
3730
  type context_Category = Category;
3506
- type context_CategoryCreatedEnvelope = CategoryCreatedEnvelope;
3507
- type context_CategoryDeletedEnvelope = CategoryDeletedEnvelope;
3508
- type context_CategoryItemAddedToCategoryEnvelope = CategoryItemAddedToCategoryEnvelope;
3509
- type context_CategoryItemRemovedFromCategoryEnvelope = CategoryItemRemovedFromCategoryEnvelope;
3510
- type context_CategoryItemsArrangedInCategoryEnvelope = CategoryItemsArrangedInCategoryEnvelope;
3511
3731
  type context_CategoryMoved = CategoryMoved;
3512
- type context_CategoryMovedEnvelope = CategoryMovedEnvelope;
3513
3732
  type context_CategoryNonNullableFields = CategoryNonNullableFields;
3514
3733
  type context_CategoryTreeNode = CategoryTreeNode;
3515
- type context_CategoryUpdatedEnvelope = CategoryUpdatedEnvelope;
3516
3734
  type context_CellStyle = CellStyle;
3517
3735
  type context_CodeBlockData = CodeBlockData;
3518
3736
  type context_CollapsibleListData = CollapsibleListData;
@@ -3532,6 +3750,8 @@ type context_Crop = Crop;
3532
3750
  declare const context_Crop: typeof Crop;
3533
3751
  type context_CursorPaging = CursorPaging;
3534
3752
  type context_CursorPagingMetadata = CursorPagingMetadata;
3753
+ type context_CursorQuery = CursorQuery;
3754
+ type context_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;
3535
3755
  type context_CursorSearch = CursorSearch;
3536
3756
  type context_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;
3537
3757
  type context_Cursors = Cursors;
@@ -3560,7 +3780,6 @@ type context_EntityCreatedEvent = EntityCreatedEvent;
3560
3780
  type context_EntityDeletedEvent = EntityDeletedEvent;
3561
3781
  type context_EntityUpdatedEvent = EntityUpdatedEvent;
3562
3782
  type context_EventData = EventData;
3563
- type context_EventMetadata = EventMetadata;
3564
3783
  type context_ExtendedFields = ExtendedFields;
3565
3784
  type context_File = File;
3566
3785
  type context_FileData = FileData;
@@ -3710,10 +3929,10 @@ declare const context_PollLayoutType: typeof PollLayoutType;
3710
3929
  type context_PollSettings = PollSettings;
3711
3930
  type context_Position = Position;
3712
3931
  declare const context_Position: typeof Position;
3932
+ type context_QueryCategoriesOptions = QueryCategoriesOptions;
3713
3933
  type context_QueryCategoriesRequest = QueryCategoriesRequest;
3714
3934
  type context_QueryCategoriesResponse = QueryCategoriesResponse;
3715
- type context_QueryV2 = QueryV2;
3716
- type context_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
3935
+ type context_QueryCategoriesResponseNonNullableFields = QueryCategoriesResponseNonNullableFields;
3717
3936
  type context_RangeAggregation = RangeAggregation;
3718
3937
  type context_RangeAggregationResult = RangeAggregationResult;
3719
3938
  type context_RangeBucket = RangeBucket;
@@ -3815,19 +4034,13 @@ declare const context_listCategoriesForItem: typeof listCategoriesForItem;
3815
4034
  declare const context_listItemsInCategory: typeof listItemsInCategory;
3816
4035
  declare const context_listTrees: typeof listTrees;
3817
4036
  declare const context_moveCategory: typeof moveCategory;
3818
- declare const context_onCategoryCreated: typeof onCategoryCreated;
3819
- declare const context_onCategoryDeleted: typeof onCategoryDeleted;
3820
- declare const context_onCategoryItemAddedToCategory: typeof onCategoryItemAddedToCategory;
3821
- declare const context_onCategoryItemRemovedFromCategory: typeof onCategoryItemRemovedFromCategory;
3822
- declare const context_onCategoryItemsArrangedInCategory: typeof onCategoryItemsArrangedInCategory;
3823
- declare const context_onCategoryMoved: typeof onCategoryMoved;
3824
- declare const context_onCategoryUpdated: typeof onCategoryUpdated;
4037
+ declare const context_queryCategories: typeof queryCategories;
3825
4038
  declare const context_searchCategories: typeof searchCategories;
3826
4039
  declare const context_setArrangedItems: typeof setArrangedItems;
3827
4040
  declare const context_updateCategory: typeof updateCategory;
3828
4041
  declare const context_updateCategoryVisibility: typeof updateCategoryVisibility;
3829
4042
  declare namespace context {
3830
- export { type context_ActionEvent as ActionEvent, type context_Aggregation as Aggregation, type context_AggregationData as AggregationData, type context_AggregationKindOneOf as AggregationKindOneOf, type context_AggregationResults as AggregationResults, type context_AggregationResultsResultOneOf as AggregationResultsResultOneOf, type context_AggregationResultsScalarResult as AggregationResultsScalarResult, context_AggregationType as AggregationType, context_Alignment as Alignment, type context_AnchorData as AnchorData, type context_App as App, type context_AppEmbedData as AppEmbedData, type context_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf, context_AppType as AppType, type context_ApplicationError as ApplicationError, type context_AudioData as AudioData, type context_Background as Background, type context_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf, context_BackgroundType as BackgroundType, type context_BaseEventMetadata as BaseEventMetadata, type context_BlockquoteData as BlockquoteData, type context_BookingData as BookingData, type context_Border as Border, type context_BorderColors as BorderColors, type context_BreadcrumbItem as BreadcrumbItem, type context_BreadcrumbItemValues as BreadcrumbItemValues, type context_BulkActionMetadata as BulkActionMetadata, type context_BulkAddItemToCategoriesOptions as BulkAddItemToCategoriesOptions, type context_BulkAddItemToCategoriesRequest as BulkAddItemToCategoriesRequest, type context_BulkAddItemToCategoriesResponse as BulkAddItemToCategoriesResponse, type context_BulkAddItemToCategoriesResponseNonNullableFields as BulkAddItemToCategoriesResponseNonNullableFields, type context_BulkAddItemsToCategoryOptions as BulkAddItemsToCategoryOptions, type context_BulkAddItemsToCategoryRequest as BulkAddItemsToCategoryRequest, type context_BulkAddItemsToCategoryResponse as BulkAddItemsToCategoryResponse, type context_BulkAddItemsToCategoryResponseNonNullableFields as BulkAddItemsToCategoryResponseNonNullableFields, type context_BulkCategoriesResult as BulkCategoriesResult, type context_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest, type context_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse, type context_BulkDeleteCategoriesByFilterRequest as BulkDeleteCategoriesByFilterRequest, type context_BulkDeleteCategoriesByFilterResponse as BulkDeleteCategoriesByFilterResponse, type context_BulkDeleteCategoriesRequest as BulkDeleteCategoriesRequest, type context_BulkDeleteCategoriesResponse as BulkDeleteCategoriesResponse, type context_BulkDeleteCategoriesResponseBulkCategoriesResult as BulkDeleteCategoriesResponseBulkCategoriesResult, type context_BulkItemToCategoriesResult as BulkItemToCategoriesResult, type context_BulkItemsToCategoryResult as BulkItemsToCategoryResult, type context_BulkRemoveItemFromCategoriesOptions as BulkRemoveItemFromCategoriesOptions, type context_BulkRemoveItemFromCategoriesRequest as BulkRemoveItemFromCategoriesRequest, type context_BulkRemoveItemFromCategoriesResponse as BulkRemoveItemFromCategoriesResponse, type context_BulkRemoveItemFromCategoriesResponseNonNullableFields as BulkRemoveItemFromCategoriesResponseNonNullableFields, type context_BulkRemoveItemsFromCategoryOptions as BulkRemoveItemsFromCategoryOptions, type context_BulkRemoveItemsFromCategoryRequest as BulkRemoveItemsFromCategoryRequest, type context_BulkRemoveItemsFromCategoryResponse as BulkRemoveItemsFromCategoryResponse, type context_BulkRemoveItemsFromCategoryResponseNonNullableFields as BulkRemoveItemsFromCategoryResponseNonNullableFields, type context_BulkUpdateCategoriesOptions as BulkUpdateCategoriesOptions, type context_BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequest, type context_BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponse, type context_BulkUpdateCategoriesResponseNonNullableFields as BulkUpdateCategoriesResponseNonNullableFields, type context_BulkUpdateCategoryVisibilityByFilterRequest as BulkUpdateCategoryVisibilityByFilterRequest, type context_BulkUpdateCategoryVisibilityByFilterResponse as BulkUpdateCategoryVisibilityByFilterResponse, type context_BulkUpdateCategoryVisibilityRequest as BulkUpdateCategoryVisibilityRequest, type context_BulkUpdateCategoryVisibilityResponse as BulkUpdateCategoryVisibilityResponse, type context_BulletedListData as BulletedListData, type context_ButtonData as ButtonData, type context_Category as Category, type context_CategoryCreatedEnvelope as CategoryCreatedEnvelope, type context_CategoryDeletedEnvelope as CategoryDeletedEnvelope, type context_CategoryItemAddedToCategoryEnvelope as CategoryItemAddedToCategoryEnvelope, type context_CategoryItemRemovedFromCategoryEnvelope as CategoryItemRemovedFromCategoryEnvelope, type context_CategoryItemsArrangedInCategoryEnvelope as CategoryItemsArrangedInCategoryEnvelope, type context_CategoryMoved as CategoryMoved, type context_CategoryMovedEnvelope as CategoryMovedEnvelope, type context_CategoryNonNullableFields as CategoryNonNullableFields, type context_CategoryTreeNode as CategoryTreeNode, type context_CategoryUpdatedEnvelope as CategoryUpdatedEnvelope, type context_CellStyle as CellStyle, type context_CodeBlockData as CodeBlockData, type context_CollapsibleListData as CollapsibleListData, type context_ColorData as ColorData, type context_Colors as Colors, type context_CommonCursors as CommonCursors, type context_CompactCategory as CompactCategory, type context_CountCategoriesOptions as CountCategoriesOptions, type context_CountCategoriesRequest as CountCategoriesRequest, type context_CountCategoriesResponse as CountCategoriesResponse, type context_CountCategoriesResponseNonNullableFields as CountCategoriesResponseNonNullableFields, type context_CreateCategoryOptions as CreateCategoryOptions, type context_CreateCategoryRequest as CreateCategoryRequest, type context_CreateCategoryResponse as CreateCategoryResponse, type context_CreateCategoryResponseNonNullableFields as CreateCategoryResponseNonNullableFields, context_Crop as Crop, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_CursorSearch as CursorSearch, type context_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, type context_Cursors as Cursors, type context_DateHistogramAggregation as DateHistogramAggregation, type context_DateHistogramResult as DateHistogramResult, type context_DateHistogramResults as DateHistogramResults, type context_Decoration as Decoration, type context_DecorationDataOneOf as DecorationDataOneOf, context_DecorationType as DecorationType, type context_DeleteCategoryRequest as DeleteCategoryRequest, type context_DeleteCategoryResponse as DeleteCategoryResponse, type context_DeprecatedSearchCategoriesWithOffsetRequest as DeprecatedSearchCategoriesWithOffsetRequest, type context_DeprecatedSearchCategoriesWithOffsetResponse as DeprecatedSearchCategoriesWithOffsetResponse, type context_Design as Design, type context_Dimensions as Dimensions, context_Direction as Direction, type context_DividerData as DividerData, type context_DocumentStyle as DocumentStyle, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EmbedData as EmbedData, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventData as EventData, type context_EventMetadata as EventMetadata, type context_ExtendedFields as ExtendedFields, type context_File as File, type context_FileData as FileData, type context_FileSource as FileSource, type context_FileSourceDataOneOf as FileSourceDataOneOf, type context_FontSizeData as FontSizeData, context_FontType as FontType, type context_GIF as GIF, type context_GIFData as GIFData, type context_GalleryData as GalleryData, type context_GalleryOptions as GalleryOptions, type context_GetArrangedItemsRequest as GetArrangedItemsRequest, type context_GetArrangedItemsResponse as GetArrangedItemsResponse, type context_GetArrangedItemsResponseNonNullableFields as GetArrangedItemsResponseNonNullableFields, type context_GetCategoriesTreeRequest as GetCategoriesTreeRequest, type context_GetCategoriesTreeResponse as GetCategoriesTreeResponse, type context_GetCategoryOptions as GetCategoryOptions, type context_GetCategoryRequest as GetCategoryRequest, type context_GetCategoryResponse as GetCategoryResponse, type context_GetCategoryResponseNonNullableFields as GetCategoryResponseNonNullableFields, type context_Gradient as Gradient, type context_GroupByValueResults as GroupByValueResults, type context_HTMLData as HTMLData, type context_HTMLDataDataOneOf as HTMLDataDataOneOf, type context_HeadingData as HeadingData, type context_Height as Height, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_Image as Image, type context_ImageData as ImageData, type context_IncludeMissingValuesOptions as IncludeMissingValuesOptions, context_InitialExpandedItems as InitialExpandedItems, context_Interval as Interval, type context_InvalidateCache as InvalidateCache, type context_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, type context_Item as Item, type context_ItemAddedToCategory as ItemAddedToCategory, type context_ItemDataOneOf as ItemDataOneOf, type context_ItemMetadata as ItemMetadata, type context_ItemReference as ItemReference, type context_ItemReferenceMetadata as ItemReferenceMetadata, type context_ItemRemovedFromCategory as ItemRemovedFromCategory, type context_ItemStyle as ItemStyle, type context_ItemsAddedToCategory as ItemsAddedToCategory, type context_ItemsArrangedInCategory as ItemsArrangedInCategory, type context_ItemsRemovedFromCategory as ItemsRemovedFromCategory, type context_Keyword as Keyword, type context_Layout as Layout, context_LayoutType as LayoutType, context_LineStyle as LineStyle, type context_Link as Link, type context_LinkData as LinkData, type context_LinkDataOneOf as LinkDataOneOf, type context_LinkPreviewData as LinkPreviewData, type context_ListCategoriesForItemOptions as ListCategoriesForItemOptions, type context_ListCategoriesForItemRequest as ListCategoriesForItemRequest, type context_ListCategoriesForItemResponse as ListCategoriesForItemResponse, type context_ListCategoriesForItemResponseNonNullableFields as ListCategoriesForItemResponseNonNullableFields, type context_ListCompactCategoriesByIdsRequest as ListCompactCategoriesByIdsRequest, type context_ListCompactCategoriesByIdsResponse as ListCompactCategoriesByIdsResponse, type context_ListItemsInCategoryOptions as ListItemsInCategoryOptions, type context_ListItemsInCategoryRequest as ListItemsInCategoryRequest, type context_ListItemsInCategoryRequestPagingMethodOneOf as ListItemsInCategoryRequestPagingMethodOneOf, type context_ListItemsInCategoryResponse as ListItemsInCategoryResponse, type context_ListItemsInCategoryResponseNonNullableFields as ListItemsInCategoryResponseNonNullableFields, type context_ListTreesRequest as ListTreesRequest, type context_ListTreesResponse as ListTreesResponse, type context_ListTreesResponseNonNullableFields as ListTreesResponseNonNullableFields, type context_ListValue as ListValue, type context_MapData as MapData, type context_MapSettings as MapSettings, context_MapType as MapType, type context_MaskedCategory as MaskedCategory, type context_Media as Media, type context_MentionData as MentionData, type context_MessageEnvelope as MessageEnvelope, type context_Metadata as Metadata, context_MissingValues as MissingValues, context_Mode as Mode, type context_MoveCategoryOptions as MoveCategoryOptions, type context_MoveCategoryRequest as MoveCategoryRequest, type context_MoveCategoryResponse as MoveCategoryResponse, type context_MoveCategoryResponseNonNullableFields as MoveCategoryResponseNonNullableFields, type context_MoveItemInCategoryRequest as MoveItemInCategoryRequest, context_MoveItemInCategoryRequestPosition as MoveItemInCategoryRequestPosition, type context_MoveItemInCategoryResponse as MoveItemInCategoryResponse, type context_NestedAggregation as NestedAggregation, type context_NestedAggregationItem as NestedAggregationItem, type context_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, type context_NestedAggregationResults as NestedAggregationResults, type context_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf, context_NestedAggregationType as NestedAggregationType, type context_NestedResultValue as NestedResultValue, type context_NestedResultValueResultOneOf as NestedResultValueResultOneOf, type context_NestedResults as NestedResults, type context_NestedValueAggregationResult as NestedValueAggregationResult, type context_Node as Node, type context_NodeDataOneOf as NodeDataOneOf, type context_NodeStyle as NodeStyle, context_NodeType as NodeType, context_NullValue as NullValue, type context_Oembed as Oembed, type context_OffsetSearch as OffsetSearch, type context_OffsetSearchPagingMethodOneOf as OffsetSearchPagingMethodOneOf, type context_Option as Option, type context_OptionDesign as OptionDesign, type context_OptionLayout as OptionLayout, type context_OrderedListData as OrderedListData, context_Orientation as Orientation, type context_PDFSettings as PDFSettings, type context_Page as Page, type context_Paging as Paging, type context_PagingMetadata as PagingMetadata, type context_PagingMetadataV2 as PagingMetadataV2, type context_ParagraphData as ParagraphData, type context_ParentCategory as ParentCategory, type context_Permissions as Permissions, type context_PlatformPagingMetadataV2 as PlatformPagingMetadataV2, type context_PlaybackOptions as PlaybackOptions, type context_PluginContainerData as PluginContainerData, context_PluginContainerDataAlignment as PluginContainerDataAlignment, type context_PluginContainerDataWidth as PluginContainerDataWidth, type context_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf, type context_Poll as Poll, type context_PollData as PollData, type context_PollDataLayout as PollDataLayout, type context_PollDesign as PollDesign, type context_PollLayout as PollLayout, context_PollLayoutDirection as PollLayoutDirection, context_PollLayoutType as PollLayoutType, type context_PollSettings as PollSettings, context_Position as Position, type context_QueryCategoriesRequest as QueryCategoriesRequest, type context_QueryCategoriesResponse as QueryCategoriesResponse, type context_QueryV2 as QueryV2, type context_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context_RangeAggregation as RangeAggregation, type context_RangeAggregationResult as RangeAggregationResult, type context_RangeBucket as RangeBucket, type context_RangeResult as RangeResult, type context_RangeResults as RangeResults, type context_Rel as Rel, context_RequestedFields as RequestedFields, type context_RestoreInfo as RestoreInfo, type context_Results as Results, type context_RichContent as RichContent, type context_ScalarAggregation as ScalarAggregation, type context_ScalarResult as ScalarResult, context_ScalarType as ScalarType, type context_SearchCategoriesOptions as SearchCategoriesOptions, type context_SearchCategoriesRequest as SearchCategoriesRequest, type context_SearchCategoriesResponse as SearchCategoriesResponse, type context_SearchCategoriesResponseNonNullableFields as SearchCategoriesResponseNonNullableFields, type context_SearchDetails as SearchDetails, type context_SeoSchema as SeoSchema, type context_SetArrangedItemsOptions as SetArrangedItemsOptions, type context_SetArrangedItemsRequest as SetArrangedItemsRequest, type context_SetArrangedItemsResponse as SetArrangedItemsResponse, type context_SetArrangedItemsResponseNonNullableFields as SetArrangedItemsResponseNonNullableFields, type context_Settings as Settings, context_SingleEntityOpsRequestedFields as SingleEntityOpsRequestedFields, context_SortDirection as SortDirection, context_SortOrder as SortOrder, context_SortType as SortType, type context_Sorting as Sorting, context_Source as Source, type context_Spoiler as Spoiler, type context_SpoilerData as SpoilerData, type context_Styles as Styles, type context_TableCellData as TableCellData, type context_TableData as TableData, type context_Tag as Tag, context_Target as Target, context_TextAlignment as TextAlignment, type context_TextData as TextData, type context_TextNodeStyle as TextNodeStyle, type context_TextStyle as TextStyle, type context_Thumbnails as Thumbnails, context_ThumbnailsAlignment as ThumbnailsAlignment, type context_TreeReference as TreeReference, context_Type as Type, type context_URI as URI, type context_UpdateCategory as UpdateCategory, type context_UpdateCategoryOptions as UpdateCategoryOptions, type context_UpdateCategoryRequest as UpdateCategoryRequest, type context_UpdateCategoryResponse as UpdateCategoryResponse, type context_UpdateCategoryResponseNonNullableFields as UpdateCategoryResponseNonNullableFields, type context_UpdateCategoryVisibilityOptions as UpdateCategoryVisibilityOptions, type context_UpdateCategoryVisibilityRequest as UpdateCategoryVisibilityRequest, type context_UpdateCategoryVisibilityResponse as UpdateCategoryVisibilityResponse, type context_UpdateCategoryVisibilityResponseNonNullableFields as UpdateCategoryVisibilityResponseNonNullableFields, type context_ValueAggregation as ValueAggregation, type context_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf, type context_ValueAggregationResult as ValueAggregationResult, type context_ValueResult as ValueResult, type context_ValueResults as ValueResults, context_VerticalAlignment as VerticalAlignment, type context_Video as Video, type context_VideoData as VideoData, context_ViewMode as ViewMode, context_ViewRole as ViewRole, context_VoteRole as VoteRole, context_WebhookIdentityType as WebhookIdentityType, context_Width as Width, context_WidthType as WidthType, context_bulkAddItemToCategories as bulkAddItemToCategories, context_bulkAddItemsToCategory as bulkAddItemsToCategory, context_bulkRemoveItemFromCategories as bulkRemoveItemFromCategories, context_bulkRemoveItemsFromCategory as bulkRemoveItemsFromCategory, context_bulkUpdateCategories as bulkUpdateCategories, context_countCategories as countCategories, context_createCategory as createCategory, context_deleteCategory as deleteCategory, context_getArrangedItems as getArrangedItems, context_getCategory as getCategory, context_listCategoriesForItem as listCategoriesForItem, context_listItemsInCategory as listItemsInCategory, context_listTrees as listTrees, context_moveCategory as moveCategory, context_onCategoryCreated as onCategoryCreated, context_onCategoryDeleted as onCategoryDeleted, context_onCategoryItemAddedToCategory as onCategoryItemAddedToCategory, context_onCategoryItemRemovedFromCategory as onCategoryItemRemovedFromCategory, context_onCategoryItemsArrangedInCategory as onCategoryItemsArrangedInCategory, context_onCategoryMoved as onCategoryMoved, context_onCategoryUpdated as onCategoryUpdated, context_searchCategories as searchCategories, context_setArrangedItems as setArrangedItems, context_updateCategory as updateCategory, context_updateCategoryVisibility as updateCategoryVisibility };
4043
+ export { type context_ActionEvent as ActionEvent, type context_Aggregation as Aggregation, type context_AggregationData as AggregationData, type context_AggregationKindOneOf as AggregationKindOneOf, type context_AggregationResults as AggregationResults, type context_AggregationResultsResultOneOf as AggregationResultsResultOneOf, type context_AggregationResultsScalarResult as AggregationResultsScalarResult, context_AggregationType as AggregationType, context_Alignment as Alignment, type context_AnchorData as AnchorData, type context_App as App, type context_AppEmbedData as AppEmbedData, type context_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf, context_AppType as AppType, type context_ApplicationError as ApplicationError, type context_AudioData as AudioData, type context_Background as Background, type context_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf, context_BackgroundType as BackgroundType, type context_BlockquoteData as BlockquoteData, type context_BookingData as BookingData, type context_Border as Border, type context_BorderColors as BorderColors, type context_BreadcrumbItem as BreadcrumbItem, type context_BreadcrumbItemValues as BreadcrumbItemValues, type context_BulkActionMetadata as BulkActionMetadata, type context_BulkAddItemToCategoriesOptions as BulkAddItemToCategoriesOptions, type context_BulkAddItemToCategoriesRequest as BulkAddItemToCategoriesRequest, type context_BulkAddItemToCategoriesResponse as BulkAddItemToCategoriesResponse, type context_BulkAddItemToCategoriesResponseNonNullableFields as BulkAddItemToCategoriesResponseNonNullableFields, type context_BulkAddItemsToCategoryOptions as BulkAddItemsToCategoryOptions, type context_BulkAddItemsToCategoryRequest as BulkAddItemsToCategoryRequest, type context_BulkAddItemsToCategoryResponse as BulkAddItemsToCategoryResponse, type context_BulkAddItemsToCategoryResponseNonNullableFields as BulkAddItemsToCategoryResponseNonNullableFields, type context_BulkCategoriesResult as BulkCategoriesResult, type context_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest, type context_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse, type context_BulkDeleteCategoriesByFilterRequest as BulkDeleteCategoriesByFilterRequest, type context_BulkDeleteCategoriesByFilterResponse as BulkDeleteCategoriesByFilterResponse, type context_BulkDeleteCategoriesRequest as BulkDeleteCategoriesRequest, type context_BulkDeleteCategoriesResponse as BulkDeleteCategoriesResponse, type context_BulkDeleteCategoriesResponseBulkCategoriesResult as BulkDeleteCategoriesResponseBulkCategoriesResult, type context_BulkItemToCategoriesResult as BulkItemToCategoriesResult, type context_BulkItemsToCategoryResult as BulkItemsToCategoryResult, type context_BulkRemoveItemFromCategoriesOptions as BulkRemoveItemFromCategoriesOptions, type context_BulkRemoveItemFromCategoriesRequest as BulkRemoveItemFromCategoriesRequest, type context_BulkRemoveItemFromCategoriesResponse as BulkRemoveItemFromCategoriesResponse, type context_BulkRemoveItemFromCategoriesResponseNonNullableFields as BulkRemoveItemFromCategoriesResponseNonNullableFields, type context_BulkRemoveItemsFromCategoryOptions as BulkRemoveItemsFromCategoryOptions, type context_BulkRemoveItemsFromCategoryRequest as BulkRemoveItemsFromCategoryRequest, type context_BulkRemoveItemsFromCategoryResponse as BulkRemoveItemsFromCategoryResponse, type context_BulkRemoveItemsFromCategoryResponseNonNullableFields as BulkRemoveItemsFromCategoryResponseNonNullableFields, type context_BulkUpdateCategoriesOptions as BulkUpdateCategoriesOptions, type context_BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequest, type context_BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponse, type context_BulkUpdateCategoriesResponseNonNullableFields as BulkUpdateCategoriesResponseNonNullableFields, type context_BulkUpdateCategoryVisibilityByFilterRequest as BulkUpdateCategoryVisibilityByFilterRequest, type context_BulkUpdateCategoryVisibilityByFilterResponse as BulkUpdateCategoryVisibilityByFilterResponse, type context_BulkUpdateCategoryVisibilityRequest as BulkUpdateCategoryVisibilityRequest, type context_BulkUpdateCategoryVisibilityResponse as BulkUpdateCategoryVisibilityResponse, type context_BulletedListData as BulletedListData, type context_ButtonData as ButtonData, type context_CategoriesQueryBuilder as CategoriesQueryBuilder, type context_CategoriesQueryResult as CategoriesQueryResult, type context_Category as Category, type context_CategoryMoved as CategoryMoved, type context_CategoryNonNullableFields as CategoryNonNullableFields, type context_CategoryTreeNode as CategoryTreeNode, type context_CellStyle as CellStyle, type context_CodeBlockData as CodeBlockData, type context_CollapsibleListData as CollapsibleListData, type context_ColorData as ColorData, type context_Colors as Colors, type context_CommonCursors as CommonCursors, type context_CompactCategory as CompactCategory, type context_CountCategoriesOptions as CountCategoriesOptions, type context_CountCategoriesRequest as CountCategoriesRequest, type context_CountCategoriesResponse as CountCategoriesResponse, type context_CountCategoriesResponseNonNullableFields as CountCategoriesResponseNonNullableFields, type context_CreateCategoryOptions as CreateCategoryOptions, type context_CreateCategoryRequest as CreateCategoryRequest, type context_CreateCategoryResponse as CreateCategoryResponse, type context_CreateCategoryResponseNonNullableFields as CreateCategoryResponseNonNullableFields, context_Crop as Crop, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_CursorQuery as CursorQuery, type context_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type context_CursorSearch as CursorSearch, type context_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, type context_Cursors as Cursors, type context_DateHistogramAggregation as DateHistogramAggregation, type context_DateHistogramResult as DateHistogramResult, type context_DateHistogramResults as DateHistogramResults, type context_Decoration as Decoration, type context_DecorationDataOneOf as DecorationDataOneOf, context_DecorationType as DecorationType, type context_DeleteCategoryRequest as DeleteCategoryRequest, type context_DeleteCategoryResponse as DeleteCategoryResponse, type context_DeprecatedSearchCategoriesWithOffsetRequest as DeprecatedSearchCategoriesWithOffsetRequest, type context_DeprecatedSearchCategoriesWithOffsetResponse as DeprecatedSearchCategoriesWithOffsetResponse, type context_Design as Design, type context_Dimensions as Dimensions, context_Direction as Direction, type context_DividerData as DividerData, type context_DocumentStyle as DocumentStyle, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EmbedData as EmbedData, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventData as EventData, type context_ExtendedFields as ExtendedFields, type context_File as File, type context_FileData as FileData, type context_FileSource as FileSource, type context_FileSourceDataOneOf as FileSourceDataOneOf, type context_FontSizeData as FontSizeData, context_FontType as FontType, type context_GIF as GIF, type context_GIFData as GIFData, type context_GalleryData as GalleryData, type context_GalleryOptions as GalleryOptions, type context_GetArrangedItemsRequest as GetArrangedItemsRequest, type context_GetArrangedItemsResponse as GetArrangedItemsResponse, type context_GetArrangedItemsResponseNonNullableFields as GetArrangedItemsResponseNonNullableFields, type context_GetCategoriesTreeRequest as GetCategoriesTreeRequest, type context_GetCategoriesTreeResponse as GetCategoriesTreeResponse, type context_GetCategoryOptions as GetCategoryOptions, type context_GetCategoryRequest as GetCategoryRequest, type context_GetCategoryResponse as GetCategoryResponse, type context_GetCategoryResponseNonNullableFields as GetCategoryResponseNonNullableFields, type context_Gradient as Gradient, type context_GroupByValueResults as GroupByValueResults, type context_HTMLData as HTMLData, type context_HTMLDataDataOneOf as HTMLDataDataOneOf, type context_HeadingData as HeadingData, type context_Height as Height, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_Image as Image, type context_ImageData as ImageData, type context_IncludeMissingValuesOptions as IncludeMissingValuesOptions, context_InitialExpandedItems as InitialExpandedItems, context_Interval as Interval, type context_InvalidateCache as InvalidateCache, type context_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, type context_Item as Item, type context_ItemAddedToCategory as ItemAddedToCategory, type context_ItemDataOneOf as ItemDataOneOf, type context_ItemMetadata as ItemMetadata, type context_ItemReference as ItemReference, type context_ItemReferenceMetadata as ItemReferenceMetadata, type context_ItemRemovedFromCategory as ItemRemovedFromCategory, type context_ItemStyle as ItemStyle, type context_ItemsAddedToCategory as ItemsAddedToCategory, type context_ItemsArrangedInCategory as ItemsArrangedInCategory, type context_ItemsRemovedFromCategory as ItemsRemovedFromCategory, type context_Keyword as Keyword, type context_Layout as Layout, context_LayoutType as LayoutType, context_LineStyle as LineStyle, type context_Link as Link, type context_LinkData as LinkData, type context_LinkDataOneOf as LinkDataOneOf, type context_LinkPreviewData as LinkPreviewData, type context_ListCategoriesForItemOptions as ListCategoriesForItemOptions, type context_ListCategoriesForItemRequest as ListCategoriesForItemRequest, type context_ListCategoriesForItemResponse as ListCategoriesForItemResponse, type context_ListCategoriesForItemResponseNonNullableFields as ListCategoriesForItemResponseNonNullableFields, type context_ListCompactCategoriesByIdsRequest as ListCompactCategoriesByIdsRequest, type context_ListCompactCategoriesByIdsResponse as ListCompactCategoriesByIdsResponse, type context_ListItemsInCategoryOptions as ListItemsInCategoryOptions, type context_ListItemsInCategoryRequest as ListItemsInCategoryRequest, type context_ListItemsInCategoryRequestPagingMethodOneOf as ListItemsInCategoryRequestPagingMethodOneOf, type context_ListItemsInCategoryResponse as ListItemsInCategoryResponse, type context_ListItemsInCategoryResponseNonNullableFields as ListItemsInCategoryResponseNonNullableFields, type context_ListTreesRequest as ListTreesRequest, type context_ListTreesResponse as ListTreesResponse, type context_ListTreesResponseNonNullableFields as ListTreesResponseNonNullableFields, type context_ListValue as ListValue, type context_MapData as MapData, type context_MapSettings as MapSettings, context_MapType as MapType, type context_MaskedCategory as MaskedCategory, type context_Media as Media, type context_MentionData as MentionData, type context_MessageEnvelope as MessageEnvelope, type context_Metadata as Metadata, context_MissingValues as MissingValues, context_Mode as Mode, type context_MoveCategoryOptions as MoveCategoryOptions, type context_MoveCategoryRequest as MoveCategoryRequest, type context_MoveCategoryResponse as MoveCategoryResponse, type context_MoveCategoryResponseNonNullableFields as MoveCategoryResponseNonNullableFields, type context_MoveItemInCategoryRequest as MoveItemInCategoryRequest, context_MoveItemInCategoryRequestPosition as MoveItemInCategoryRequestPosition, type context_MoveItemInCategoryResponse as MoveItemInCategoryResponse, type context_NestedAggregation as NestedAggregation, type context_NestedAggregationItem as NestedAggregationItem, type context_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, type context_NestedAggregationResults as NestedAggregationResults, type context_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf, context_NestedAggregationType as NestedAggregationType, type context_NestedResultValue as NestedResultValue, type context_NestedResultValueResultOneOf as NestedResultValueResultOneOf, type context_NestedResults as NestedResults, type context_NestedValueAggregationResult as NestedValueAggregationResult, type context_Node as Node, type context_NodeDataOneOf as NodeDataOneOf, type context_NodeStyle as NodeStyle, context_NodeType as NodeType, context_NullValue as NullValue, type context_Oembed as Oembed, type context_OffsetSearch as OffsetSearch, type context_OffsetSearchPagingMethodOneOf as OffsetSearchPagingMethodOneOf, type context_Option as Option, type context_OptionDesign as OptionDesign, type context_OptionLayout as OptionLayout, type context_OrderedListData as OrderedListData, context_Orientation as Orientation, type context_PDFSettings as PDFSettings, type context_Page as Page, type context_Paging as Paging, type context_PagingMetadata as PagingMetadata, type context_PagingMetadataV2 as PagingMetadataV2, type context_ParagraphData as ParagraphData, type context_ParentCategory as ParentCategory, type context_Permissions as Permissions, type context_PlatformPagingMetadataV2 as PlatformPagingMetadataV2, type context_PlaybackOptions as PlaybackOptions, type context_PluginContainerData as PluginContainerData, context_PluginContainerDataAlignment as PluginContainerDataAlignment, type context_PluginContainerDataWidth as PluginContainerDataWidth, type context_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf, type context_Poll as Poll, type context_PollData as PollData, type context_PollDataLayout as PollDataLayout, type context_PollDesign as PollDesign, type context_PollLayout as PollLayout, context_PollLayoutDirection as PollLayoutDirection, context_PollLayoutType as PollLayoutType, type context_PollSettings as PollSettings, context_Position as Position, type context_QueryCategoriesOptions as QueryCategoriesOptions, type context_QueryCategoriesRequest as QueryCategoriesRequest, type context_QueryCategoriesResponse as QueryCategoriesResponse, type context_QueryCategoriesResponseNonNullableFields as QueryCategoriesResponseNonNullableFields, type context_RangeAggregation as RangeAggregation, type context_RangeAggregationResult as RangeAggregationResult, type context_RangeBucket as RangeBucket, type context_RangeResult as RangeResult, type context_RangeResults as RangeResults, type context_Rel as Rel, context_RequestedFields as RequestedFields, type context_RestoreInfo as RestoreInfo, type context_Results as Results, type context_RichContent as RichContent, type context_ScalarAggregation as ScalarAggregation, type context_ScalarResult as ScalarResult, context_ScalarType as ScalarType, type context_SearchCategoriesOptions as SearchCategoriesOptions, type context_SearchCategoriesRequest as SearchCategoriesRequest, type context_SearchCategoriesResponse as SearchCategoriesResponse, type context_SearchCategoriesResponseNonNullableFields as SearchCategoriesResponseNonNullableFields, type context_SearchDetails as SearchDetails, type context_SeoSchema as SeoSchema, type context_SetArrangedItemsOptions as SetArrangedItemsOptions, type context_SetArrangedItemsRequest as SetArrangedItemsRequest, type context_SetArrangedItemsResponse as SetArrangedItemsResponse, type context_SetArrangedItemsResponseNonNullableFields as SetArrangedItemsResponseNonNullableFields, type context_Settings as Settings, context_SingleEntityOpsRequestedFields as SingleEntityOpsRequestedFields, context_SortDirection as SortDirection, context_SortOrder as SortOrder, context_SortType as SortType, type context_Sorting as Sorting, context_Source as Source, type context_Spoiler as Spoiler, type context_SpoilerData as SpoilerData, type context_Styles as Styles, type context_TableCellData as TableCellData, type context_TableData as TableData, type context_Tag as Tag, context_Target as Target, context_TextAlignment as TextAlignment, type context_TextData as TextData, type context_TextNodeStyle as TextNodeStyle, type context_TextStyle as TextStyle, type context_Thumbnails as Thumbnails, context_ThumbnailsAlignment as ThumbnailsAlignment, type context_TreeReference as TreeReference, context_Type as Type, type context_URI as URI, type context_UpdateCategory as UpdateCategory, type context_UpdateCategoryOptions as UpdateCategoryOptions, type context_UpdateCategoryRequest as UpdateCategoryRequest, type context_UpdateCategoryResponse as UpdateCategoryResponse, type context_UpdateCategoryResponseNonNullableFields as UpdateCategoryResponseNonNullableFields, type context_UpdateCategoryVisibilityOptions as UpdateCategoryVisibilityOptions, type context_UpdateCategoryVisibilityRequest as UpdateCategoryVisibilityRequest, type context_UpdateCategoryVisibilityResponse as UpdateCategoryVisibilityResponse, type context_UpdateCategoryVisibilityResponseNonNullableFields as UpdateCategoryVisibilityResponseNonNullableFields, type context_ValueAggregation as ValueAggregation, type context_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf, type context_ValueAggregationResult as ValueAggregationResult, type context_ValueResult as ValueResult, type context_ValueResults as ValueResults, context_VerticalAlignment as VerticalAlignment, type context_Video as Video, type context_VideoData as VideoData, context_ViewMode as ViewMode, context_ViewRole as ViewRole, context_VoteRole as VoteRole, context_WebhookIdentityType as WebhookIdentityType, context_Width as Width, context_WidthType as WidthType, context_bulkAddItemToCategories as bulkAddItemToCategories, context_bulkAddItemsToCategory as bulkAddItemsToCategory, context_bulkRemoveItemFromCategories as bulkRemoveItemFromCategories, context_bulkRemoveItemsFromCategory as bulkRemoveItemsFromCategory, context_bulkUpdateCategories as bulkUpdateCategories, context_countCategories as countCategories, context_createCategory as createCategory, context_deleteCategory as deleteCategory, context_getArrangedItems as getArrangedItems, context_getCategory as getCategory, context_listCategoriesForItem as listCategoriesForItem, context_listItemsInCategory as listItemsInCategory, context_listTrees as listTrees, context_moveCategory as moveCategory, context_queryCategories as queryCategories, context_searchCategories as searchCategories, context_setArrangedItems as setArrangedItems, context_updateCategory as updateCategory, context_updateCategoryVisibility as updateCategoryVisibility };
3831
4044
  }
3832
4045
 
3833
4046
  export { context as categories };