@wix/auto_sdk_categories_categories 1.0.61 → 1.0.63

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.
Files changed (52) hide show
  1. package/build/{categories-v1-category-categories.universal-Bn_iHkbq.d.mts → cjs/categories-v1-category-categories.universal-C77jUy-2.d.ts} +1063 -124
  2. package/build/cjs/index.d.ts +311 -0
  3. package/build/{internal → cjs}/index.js +75 -20
  4. package/build/cjs/index.js.map +1 -0
  5. package/build/cjs/index.typings.d.ts +35 -0
  6. package/build/cjs/index.typings.js +2572 -0
  7. package/build/cjs/index.typings.js.map +1 -0
  8. package/build/{internal/meta.d.mts → cjs/meta.d.ts} +290 -46
  9. package/build/{categories-v1-category-categories.universal-Bn_iHkbq.d.ts → es/categories-v1-category-categories.universal-C77jUy-2.d.mts} +1063 -124
  10. package/build/es/index.d.mts +311 -0
  11. package/build/{internal → es}/index.mjs +68 -20
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/index.typings.d.mts +35 -0
  14. package/build/es/index.typings.mjs +2477 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/{internal/meta.d.ts → es/meta.d.mts} +290 -46
  17. package/build/es/package.json +3 -0
  18. package/build/internal/{categories-v1-category-categories.universal-Bn_iHkbq.d.mts → cjs/categories-v1-category-categories.universal-C77jUy-2.d.ts} +1063 -124
  19. package/build/internal/cjs/index.d.ts +311 -0
  20. package/build/{index.js → internal/cjs/index.js} +75 -20
  21. package/build/internal/cjs/index.js.map +1 -0
  22. package/build/internal/cjs/index.typings.d.ts +35 -0
  23. package/build/internal/cjs/index.typings.js +2572 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -0
  25. package/build/{meta.d.mts → internal/cjs/meta.d.ts} +290 -46
  26. package/build/internal/cjs/meta.js.map +1 -0
  27. package/build/internal/{categories-v1-category-categories.universal-Bn_iHkbq.d.ts → es/categories-v1-category-categories.universal-C77jUy-2.d.mts} +1063 -124
  28. package/build/internal/es/index.d.mts +311 -0
  29. package/build/{index.mjs → internal/es/index.mjs} +68 -20
  30. package/build/internal/es/index.mjs.map +1 -0
  31. package/build/internal/es/index.typings.d.mts +35 -0
  32. package/build/internal/es/index.typings.mjs +2477 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -0
  34. package/build/{meta.d.ts → internal/es/meta.d.mts} +290 -46
  35. package/build/internal/es/meta.mjs.map +1 -0
  36. package/package.json +12 -11
  37. package/build/index.d.mts +0 -279
  38. package/build/index.d.ts +0 -279
  39. package/build/index.js.map +0 -1
  40. package/build/index.mjs.map +0 -1
  41. package/build/internal/index.d.mts +0 -279
  42. package/build/internal/index.d.ts +0 -279
  43. package/build/internal/index.js.map +0 -1
  44. package/build/internal/index.mjs.map +0 -1
  45. package/build/meta.js.map +0 -1
  46. package/build/meta.mjs.map +0 -1
  47. /package/build/{internal → cjs}/meta.js +0 -0
  48. /package/build/{internal → cjs}/meta.js.map +0 -0
  49. /package/build/{internal → es}/meta.mjs +0 -0
  50. /package/build/{internal → es}/meta.mjs.map +0 -0
  51. /package/build/{meta.js → internal/cjs/meta.js} +0 -0
  52. /package/build/{meta.mjs → internal/es/meta.mjs} +0 -0
@@ -1,3 +1,5 @@
1
+ import { SearchSpec, Search, NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  interface Category {
2
4
  /**
3
5
  * Category ID.
@@ -378,7 +380,7 @@ interface ButtonData {
378
380
  /** Styling for the button's container. */
379
381
  containerData?: PluginContainerData;
380
382
  /** The button type. */
381
- type?: TypeWithLiterals;
383
+ type?: ButtonDataTypeWithLiterals;
382
384
  /** Styling for the button. */
383
385
  styles?: Styles;
384
386
  /** The text to display on the button. */
@@ -486,14 +488,14 @@ interface Height {
486
488
  /** A custom height value in pixels. */
487
489
  custom?: string | null;
488
490
  }
489
- declare enum Type {
491
+ declare enum ButtonDataType {
490
492
  /** Regular link button */
491
493
  LINK = "LINK",
492
494
  /** Triggers custom action that is defined in plugin configuration by the consumer */
493
495
  ACTION = "ACTION"
494
496
  }
495
497
  /** @enumType */
496
- type TypeWithLiterals = Type | 'LINK' | 'ACTION';
498
+ type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
497
499
  interface Styles {
498
500
  /**
499
501
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -626,7 +628,7 @@ interface DividerData {
626
628
  /** Divider width. */
627
629
  width?: WidthWithLiterals;
628
630
  /** Divider alignment. */
629
- alignment?: AlignmentWithLiterals;
631
+ alignment?: DividerDataAlignmentWithLiterals;
630
632
  }
631
633
  declare enum LineStyle {
632
634
  /** Single Line */
@@ -650,7 +652,7 @@ declare enum Width {
650
652
  }
651
653
  /** @enumType */
652
654
  type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
653
- declare enum Alignment {
655
+ declare enum DividerDataAlignment {
654
656
  /** Center alignment */
655
657
  CENTER = "CENTER",
656
658
  /** Left alignment */
@@ -659,7 +661,7 @@ declare enum Alignment {
659
661
  RIGHT = "RIGHT"
660
662
  }
661
663
  /** @enumType */
662
- type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
664
+ type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
663
665
  interface FileData {
664
666
  /** Styling for the file's container. */
665
667
  containerData?: PluginContainerData;
@@ -784,7 +786,7 @@ interface ItemDataOneOf {
784
786
  }
785
787
  interface GalleryOptions {
786
788
  /** Gallery layout. */
787
- layout?: Layout;
789
+ layout?: GalleryOptionsLayout;
788
790
  /** Styling for gallery items. */
789
791
  item?: ItemStyle;
790
792
  /** Styling for gallery thumbnail images. */
@@ -844,7 +846,7 @@ declare enum ThumbnailsAlignment {
844
846
  }
845
847
  /** @enumType */
846
848
  type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
847
- interface Layout {
849
+ interface GalleryOptionsLayout {
848
850
  /** Gallery layout type. */
849
851
  type?: LayoutTypeWithLiterals;
850
852
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -1294,6 +1296,10 @@ interface Decoration extends DecorationDataOneOf {
1294
1296
  spoilerData?: SpoilerData;
1295
1297
  /** Data for a strikethrough decoration. Defaults to `true`. */
1296
1298
  strikethroughData?: boolean | null;
1299
+ /** Data for a superscript decoration. Defaults to `true`. */
1300
+ superscriptData?: boolean | null;
1301
+ /** Data for a subscript decoration. Defaults to `true`. */
1302
+ subscriptData?: boolean | null;
1297
1303
  /** The type of decoration to apply. */
1298
1304
  type?: DecorationTypeWithLiterals;
1299
1305
  }
@@ -1319,6 +1325,10 @@ interface DecorationDataOneOf {
1319
1325
  spoilerData?: SpoilerData;
1320
1326
  /** Data for a strikethrough decoration. Defaults to `true`. */
1321
1327
  strikethroughData?: boolean | null;
1328
+ /** Data for a superscript decoration. Defaults to `true`. */
1329
+ superscriptData?: boolean | null;
1330
+ /** Data for a subscript decoration. Defaults to `true`. */
1331
+ subscriptData?: boolean | null;
1322
1332
  }
1323
1333
  declare enum DecorationType {
1324
1334
  BOLD = "BOLD",
@@ -1331,10 +1341,12 @@ declare enum DecorationType {
1331
1341
  COLOR = "COLOR",
1332
1342
  FONT_SIZE = "FONT_SIZE",
1333
1343
  EXTERNAL = "EXTERNAL",
1334
- STRIKETHROUGH = "STRIKETHROUGH"
1344
+ STRIKETHROUGH = "STRIKETHROUGH",
1345
+ SUPERSCRIPT = "SUPERSCRIPT",
1346
+ SUBSCRIPT = "SUBSCRIPT"
1335
1347
  }
1336
1348
  /** @enumType */
1337
- type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
1349
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
1338
1350
  interface AnchorData {
1339
1351
  /** The target node's ID. */
1340
1352
  anchor?: string;
@@ -1393,6 +1405,36 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1393
1405
  url?: string | null;
1394
1406
  /** An image for the embedded content. */
1395
1407
  image?: Media;
1408
+ /** Whether to hide the image. */
1409
+ hideImage?: boolean | null;
1410
+ /** Whether to hide the title. */
1411
+ hideTitle?: boolean | null;
1412
+ /** Whether to hide the price. */
1413
+ hidePrice?: boolean | null;
1414
+ /** Whether to hide the description (Event and Booking). */
1415
+ hideDescription?: boolean | null;
1416
+ /** Whether to hide the date and time (Event). */
1417
+ hideDateTime?: boolean | null;
1418
+ /** Whether to hide the location (Event). */
1419
+ hideLocation?: boolean | null;
1420
+ /** Whether to hide the duration (Booking). */
1421
+ hideDuration?: boolean | null;
1422
+ /** Whether to hide the button. */
1423
+ hideButton?: boolean | null;
1424
+ /** Whether to hide the ribbon. */
1425
+ hideRibbon?: boolean | null;
1426
+ /** Button styling options. */
1427
+ buttonStyles?: ButtonStyles;
1428
+ /** Image styling options. */
1429
+ imageStyles?: ImageStyles;
1430
+ /** Ribbon styling options. */
1431
+ ribbonStyles?: RibbonStyles;
1432
+ /** Card styling options. */
1433
+ cardStyles?: CardStyles;
1434
+ /** Styling for the app embed's container. */
1435
+ containerData?: PluginContainerData;
1436
+ /** Pricing data for embedded Wix App content. */
1437
+ pricingData?: PricingData;
1396
1438
  }
1397
1439
  /** @oneof */
1398
1440
  interface AppEmbedDataAppDataOneOf {
@@ -1401,6 +1443,66 @@ interface AppEmbedDataAppDataOneOf {
1401
1443
  /** Data for embedded Wix Events content. */
1402
1444
  eventData?: EventData;
1403
1445
  }
1446
+ declare enum ImageStylesPosition {
1447
+ /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
1448
+ START = "START",
1449
+ /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
1450
+ END = "END",
1451
+ /** Image positioned at the top */
1452
+ TOP = "TOP"
1453
+ }
1454
+ /** @enumType */
1455
+ type ImageStylesPositionWithLiterals = ImageStylesPosition | 'START' | 'END' | 'TOP';
1456
+ declare enum AspectRatio {
1457
+ /** 1:1 aspect ratio */
1458
+ SQUARE = "SQUARE",
1459
+ /** 16:9 aspect ratio */
1460
+ RECTANGLE = "RECTANGLE"
1461
+ }
1462
+ /** @enumType */
1463
+ type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
1464
+ declare enum Resizing {
1465
+ /** Fill the container, may crop the image */
1466
+ FILL = "FILL",
1467
+ /** Fit the image within the container */
1468
+ FIT = "FIT"
1469
+ }
1470
+ /** @enumType */
1471
+ type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
1472
+ declare enum Placement {
1473
+ /** Ribbon placed on the image */
1474
+ IMAGE = "IMAGE",
1475
+ /** Ribbon placed on the product information */
1476
+ PRODUCT_INFO = "PRODUCT_INFO"
1477
+ }
1478
+ /** @enumType */
1479
+ type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
1480
+ declare enum Type {
1481
+ /** Card with visible border and background */
1482
+ CONTAINED = "CONTAINED",
1483
+ /** Card without visible border */
1484
+ FRAMELESS = "FRAMELESS"
1485
+ }
1486
+ /** @enumType */
1487
+ type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
1488
+ declare enum Alignment {
1489
+ /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
1490
+ START = "START",
1491
+ /** Content centered */
1492
+ CENTER = "CENTER",
1493
+ /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
1494
+ END = "END"
1495
+ }
1496
+ /** @enumType */
1497
+ type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
1498
+ declare enum Layout {
1499
+ /** Elements stacked vertically */
1500
+ STACKED = "STACKED",
1501
+ /** Elements arranged horizontally */
1502
+ SIDE_BY_SIDE = "SIDE_BY_SIDE"
1503
+ }
1504
+ /** @enumType */
1505
+ type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
1404
1506
  declare enum AppType {
1405
1507
  PRODUCT = "PRODUCT",
1406
1508
  EVENT = "EVENT",
@@ -1418,6 +1520,149 @@ interface EventData {
1418
1520
  /** Event location. */
1419
1521
  location?: string | null;
1420
1522
  }
1523
+ interface ButtonStyles {
1524
+ /** Text to display on the button. */
1525
+ buttonText?: string | null;
1526
+ /** Border width in pixels. */
1527
+ borderWidth?: number | null;
1528
+ /** Border radius in pixels. */
1529
+ borderRadius?: number | null;
1530
+ /**
1531
+ * Border color as a hexadecimal value.
1532
+ * @format COLOR_HEX
1533
+ */
1534
+ borderColor?: string | null;
1535
+ /**
1536
+ * Text color as a hexadecimal value.
1537
+ * @format COLOR_HEX
1538
+ */
1539
+ textColor?: string | null;
1540
+ /**
1541
+ * Background color as a hexadecimal value.
1542
+ * @format COLOR_HEX
1543
+ */
1544
+ backgroundColor?: string | null;
1545
+ /**
1546
+ * Border color as a hexadecimal value (hover state).
1547
+ * @format COLOR_HEX
1548
+ */
1549
+ borderColorHover?: string | null;
1550
+ /**
1551
+ * Text color as a hexadecimal value (hover state).
1552
+ * @format COLOR_HEX
1553
+ */
1554
+ textColorHover?: string | null;
1555
+ /**
1556
+ * Background color as a hexadecimal value (hover state).
1557
+ * @format COLOR_HEX
1558
+ */
1559
+ backgroundColorHover?: string | null;
1560
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
1561
+ buttonSize?: string | null;
1562
+ }
1563
+ interface ImageStyles {
1564
+ /** Whether to hide the image. */
1565
+ hideImage?: boolean | null;
1566
+ /** Position of image. Defaults to `START`. */
1567
+ imagePosition?: ImageStylesPositionWithLiterals;
1568
+ /** Aspect ratio for the image. Defaults to `SQUARE`. */
1569
+ aspectRatio?: AspectRatioWithLiterals;
1570
+ /** How the image should be resized. Defaults to `FILL`. */
1571
+ resizing?: ResizingWithLiterals;
1572
+ /**
1573
+ * Image border color as a hexadecimal value.
1574
+ * @format COLOR_HEX
1575
+ */
1576
+ borderColor?: string | null;
1577
+ /** Image border width in pixels. */
1578
+ borderWidth?: number | null;
1579
+ /** Image border radius in pixels. */
1580
+ borderRadius?: number | null;
1581
+ }
1582
+ interface RibbonStyles {
1583
+ /** Text to display on the ribbon. */
1584
+ ribbonText?: string | null;
1585
+ /**
1586
+ * Ribbon background color as a hexadecimal value.
1587
+ * @format COLOR_HEX
1588
+ */
1589
+ backgroundColor?: string | null;
1590
+ /**
1591
+ * Ribbon text color as a hexadecimal value.
1592
+ * @format COLOR_HEX
1593
+ */
1594
+ textColor?: string | null;
1595
+ /**
1596
+ * Ribbon border color as a hexadecimal value.
1597
+ * @format COLOR_HEX
1598
+ */
1599
+ borderColor?: string | null;
1600
+ /** Ribbon border width in pixels. */
1601
+ borderWidth?: number | null;
1602
+ /** Ribbon border radius in pixels. */
1603
+ borderRadius?: number | null;
1604
+ /** Placement of the ribbon. Defaults to `IMAGE`. */
1605
+ ribbonPlacement?: PlacementWithLiterals;
1606
+ }
1607
+ interface CardStyles {
1608
+ /**
1609
+ * Card background color as a hexadecimal value.
1610
+ * @format COLOR_HEX
1611
+ */
1612
+ backgroundColor?: string | null;
1613
+ /**
1614
+ * Card border color as a hexadecimal value.
1615
+ * @format COLOR_HEX
1616
+ */
1617
+ borderColor?: string | null;
1618
+ /** Card border width in pixels. */
1619
+ borderWidth?: number | null;
1620
+ /** Card border radius in pixels. */
1621
+ borderRadius?: number | null;
1622
+ /** Card type. Defaults to `CONTAINED`. */
1623
+ type?: TypeWithLiterals;
1624
+ /** Content alignment. Defaults to `START`. */
1625
+ alignment?: AlignmentWithLiterals;
1626
+ /** Layout for title and price. Defaults to `STACKED`. */
1627
+ titlePriceLayout?: LayoutWithLiterals;
1628
+ /**
1629
+ * Title text color as a hexadecimal value.
1630
+ * @format COLOR_HEX
1631
+ */
1632
+ titleColor?: string | null;
1633
+ /**
1634
+ * Text color as a hexadecimal value.
1635
+ * @format COLOR_HEX
1636
+ */
1637
+ textColor?: string | null;
1638
+ }
1639
+ interface PricingData {
1640
+ /**
1641
+ * Minimum numeric price value as string (e.g., "10.99").
1642
+ * @decimalValue options { maxScale:2 }
1643
+ */
1644
+ valueFrom?: string | null;
1645
+ /**
1646
+ * Maximum numeric price value as string (e.g., "19.99").
1647
+ * @decimalValue options { maxScale:2 }
1648
+ */
1649
+ valueTo?: string | null;
1650
+ /**
1651
+ * Numeric price value as string after discount application (e.g., "15.99").
1652
+ * @decimalValue options { maxScale:2 }
1653
+ */
1654
+ discountedValue?: string | null;
1655
+ /**
1656
+ * Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
1657
+ * @format CURRENCY
1658
+ */
1659
+ currency?: string | null;
1660
+ /**
1661
+ * Pricing plan ID.
1662
+ * @format GUID
1663
+ */
1664
+ pricingPlanId?: string | null;
1665
+ }
1421
1666
  interface VideoData {
1422
1667
  /** Styling for the video's container. */
1423
1668
  containerData?: PluginContainerData;
@@ -1590,6 +1835,8 @@ declare enum NullValue {
1590
1835
  /** Null value. */
1591
1836
  NULL_VALUE = "NULL_VALUE"
1592
1837
  }
1838
+ /** @enumType */
1839
+ type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1593
1840
  /**
1594
1841
  * `ListValue` is a wrapper around a repeated field of values.
1595
1842
  *
@@ -2790,17 +3037,17 @@ interface MoveCategoryResponse {
2790
3037
  */
2791
3038
  categoriesAfterMove?: string[];
2792
3039
  }
2793
- interface BulkCreateCategoriesRequest {
3040
+ interface BulkUpdateCategoriesRequest {
2794
3041
  /**
2795
- * List of categories to be created.
3042
+ * List of categories to update.
2796
3043
  * @minSize 1
2797
3044
  * @maxSize 100
2798
3045
  */
2799
- categories?: Category[];
3046
+ categories: MaskedCategory[];
2800
3047
  /** Category tree reference details. */
2801
- treeReference?: TreeReference;
3048
+ treeReference: TreeReference;
2802
3049
  /**
2803
- * Whether to return the category entity in the response.
3050
+ * Whether to return the full category entity in the response.
2804
3051
  *
2805
3052
  * Default: `false`
2806
3053
  */
@@ -2811,9 +3058,13 @@ interface BulkCreateCategoriesRequest {
2811
3058
  */
2812
3059
  fields?: RequestedFieldsWithLiterals[];
2813
3060
  }
2814
- interface BulkCreateCategoriesResponse {
3061
+ interface MaskedCategory {
3062
+ /** Category to update. */
3063
+ category?: Category;
3064
+ }
3065
+ interface BulkUpdateCategoriesResponse {
2815
3066
  /**
2816
- * Categories created by bulk action.
3067
+ * Categories updated by bulk action.
2817
3068
  * @minSize 1
2818
3069
  * @maxSize 100
2819
3070
  */
@@ -2860,41 +3111,6 @@ interface BulkActionMetadata {
2860
3111
  /** Number of failures without details because detailed failure threshold was exceeded. */
2861
3112
  undetailedFailures?: number;
2862
3113
  }
2863
- interface BulkUpdateCategoriesRequest {
2864
- /**
2865
- * List of categories to update.
2866
- * @minSize 1
2867
- * @maxSize 100
2868
- */
2869
- categories: MaskedCategory[];
2870
- /** Category tree reference details. */
2871
- treeReference: TreeReference;
2872
- /**
2873
- * Whether to return the full category entity in the response.
2874
- *
2875
- * Default: `false`
2876
- */
2877
- returnEntity?: boolean;
2878
- /**
2879
- * Fields to include in the response.
2880
- * @maxSize 100
2881
- */
2882
- fields?: RequestedFieldsWithLiterals[];
2883
- }
2884
- interface MaskedCategory {
2885
- /** Category to update. */
2886
- category?: Category;
2887
- }
2888
- interface BulkUpdateCategoriesResponse {
2889
- /**
2890
- * Categories updated by bulk action.
2891
- * @minSize 1
2892
- * @maxSize 100
2893
- */
2894
- results?: BulkCategoriesResult[];
2895
- /** Bulk action metadata. */
2896
- bulkActionMetadata?: BulkActionMetadata;
2897
- }
2898
3114
  interface UpdateCategoryVisibilityRequest {
2899
3115
  /**
2900
3116
  * Category ID.
@@ -2957,30 +3173,6 @@ interface BulkShowCategoriesResponse {
2957
3173
  /** Bulk action metadata. */
2958
3174
  bulkActionMetadata?: BulkActionMetadata;
2959
3175
  }
2960
- interface BulkUpdateCategoryVisibilityByFilterRequest {
2961
- /**
2962
- * Filter object in the following format:
2963
- * `"filter" : {
2964
- * "fieldName1": "value1",
2965
- * "fieldName2":{"$operator":"value2"}
2966
- * }`
2967
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2968
- */
2969
- filter?: Record<string, any> | null;
2970
- /** Category tree reference details. */
2971
- treeReference?: TreeReference;
2972
- /** value to set `visible` to. This value will be set for all categories that match the filter */
2973
- visible?: boolean;
2974
- }
2975
- interface BulkUpdateCategoryVisibilityByFilterResponse {
2976
- /**
2977
- * Job ID.
2978
- *
2979
- * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
2980
- * @format GUID
2981
- */
2982
- jobId?: string;
2983
- }
2984
3176
  interface BulkDeleteCategoriesRequest {
2985
3177
  /**
2986
3178
  * IDs of categories to be deleted.
@@ -3004,28 +3196,6 @@ interface BulkDeleteCategoriesResponseBulkCategoriesResult {
3004
3196
  /** Information about successful action or error for failure. */
3005
3197
  itemMetadata?: ItemMetadata;
3006
3198
  }
3007
- interface BulkDeleteCategoriesByFilterRequest {
3008
- /**
3009
- * Filter object in the following format:
3010
- * `"filter" : {
3011
- * "fieldName1": "value1",
3012
- * "fieldName2":{"$operator":"value2"}
3013
- * }`
3014
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
3015
- */
3016
- filter?: Record<string, any> | null;
3017
- /** Category tree reference details. */
3018
- treeReference?: TreeReference;
3019
- }
3020
- interface BulkDeleteCategoriesByFilterResponse {
3021
- /**
3022
- * Job ID.
3023
- *
3024
- * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
3025
- * @format GUID
3026
- */
3027
- jobId?: string;
3028
- }
3029
3199
  interface BulkAddItemsToCategoryRequest {
3030
3200
  /**
3031
3201
  * Category ID.
@@ -3487,6 +3657,105 @@ declare enum WebhookIdentityType {
3487
3657
  }
3488
3658
  /** @enumType */
3489
3659
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3660
+ type CreateCategoryApplicationErrors = {
3661
+ code?: 'NAMESPACE_NOT_FOUND_IN_DEV_CENTER';
3662
+ description?: string;
3663
+ data?: Record<string, any>;
3664
+ } | {
3665
+ code?: 'DUPLICATE_SLUG';
3666
+ description?: string;
3667
+ data?: Record<string, any>;
3668
+ } | {
3669
+ code?: 'CATEGORIES_LIMIT_PER_TREE_EXCEEDED';
3670
+ description?: string;
3671
+ data?: Record<string, any>;
3672
+ } | {
3673
+ code?: 'PARENT_CATEGORY_NOT_IN_TREE';
3674
+ description?: string;
3675
+ data?: Record<string, any>;
3676
+ } | {
3677
+ code?: 'TREES_LIMIT_EXCEEDED';
3678
+ description?: string;
3679
+ data?: Record<string, any>;
3680
+ } | {
3681
+ code?: 'CATEGORY_DEPTH_LIMIT_EXCEEDED';
3682
+ description?: string;
3683
+ data?: Record<string, any>;
3684
+ } | {
3685
+ code?: 'PARENT_CATEGORY_HIDDEN';
3686
+ description?: string;
3687
+ data?: Record<string, any>;
3688
+ };
3689
+ type UpdateCategoryApplicationErrors = {
3690
+ code?: 'DUPLICATE_SLUG';
3691
+ description?: string;
3692
+ data?: Record<string, any>;
3693
+ } | {
3694
+ code?: 'REMOVED_SLUG';
3695
+ description?: string;
3696
+ data?: Record<string, any>;
3697
+ };
3698
+ type DeleteCategoryApplicationErrors = {
3699
+ code?: 'MANAGED_CATEGORY_OPERATION_NOT_ALLOWED';
3700
+ description?: string;
3701
+ data?: Record<string, any>;
3702
+ };
3703
+ type MoveCategoryApplicationErrors = {
3704
+ code?: 'PARENT_CATEGORY_NOT_IN_TREE';
3705
+ description?: string;
3706
+ data?: Record<string, any>;
3707
+ } | {
3708
+ code?: 'CATEGORY_DEPTH_LIMIT_EXCEEDED';
3709
+ description?: string;
3710
+ data?: Record<string, any>;
3711
+ } | {
3712
+ code?: 'TREE_CYCLE_DETECTED';
3713
+ description?: string;
3714
+ data?: Record<string, any>;
3715
+ } | {
3716
+ code?: 'MISSING_AFTER_CATEGORY';
3717
+ description?: string;
3718
+ data?: Record<string, any>;
3719
+ } | {
3720
+ code?: 'AFTER_CATEGORY_NOT_IN_PARENT';
3721
+ description?: string;
3722
+ data?: Record<string, any>;
3723
+ };
3724
+ type BulkUpdateCategoriesApplicationErrors = {
3725
+ code?: 'UPDATE_OF_FIELD_NOT_ALLOWED';
3726
+ description?: string;
3727
+ data?: Record<string, any>;
3728
+ };
3729
+ type UpdateCategoryVisibilityApplicationErrors = {
3730
+ code?: 'PARENT_CATEGORY_HIDDEN';
3731
+ description?: string;
3732
+ data?: Record<string, any>;
3733
+ };
3734
+ type BulkAddItemsToCategoryApplicationErrors = {
3735
+ code?: 'MANAGED_CATEGORY_OPERATION_NOT_ALLOWED';
3736
+ description?: string;
3737
+ data?: Record<string, any>;
3738
+ };
3739
+ type BulkAddItemToCategoriesApplicationErrors = {
3740
+ code?: 'MANAGED_CATEGORY_OPERATION_NOT_ALLOWED';
3741
+ description?: string;
3742
+ data?: Record<string, any>;
3743
+ };
3744
+ type BulkRemoveItemsFromCategoryApplicationErrors = {
3745
+ code?: 'MANAGED_CATEGORY_OPERATION_NOT_ALLOWED';
3746
+ description?: string;
3747
+ data?: Record<string, any>;
3748
+ };
3749
+ type BulkRemoveItemFromCategoriesApplicationErrors = {
3750
+ code?: 'MANAGED_CATEGORY_OPERATION_NOT_ALLOWED';
3751
+ description?: string;
3752
+ data?: Record<string, any>;
3753
+ };
3754
+ type SetArrangedItemsApplicationErrors = {
3755
+ code?: 'ITEM_NOT_IN_CATEGORY';
3756
+ description?: string;
3757
+ data?: Record<string, any>;
3758
+ };
3490
3759
  interface BaseEventMetadata {
3491
3760
  /**
3492
3761
  * App instance ID.
@@ -3535,29 +3804,237 @@ interface CategoryMovedEnvelope {
3535
3804
  data: CategoryMoved;
3536
3805
  metadata: EventMetadata;
3537
3806
  }
3807
+ /**
3808
+ * Triggered when a category is moved.
3809
+ * @permissionScope Manage Stores - all permissions
3810
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3811
+ * @permissionScope Manage Stores
3812
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3813
+ * @permissionScope Read categories
3814
+ * @permissionScopeId SCOPE.CATEGORIES.CATEGORY_READ
3815
+ * @permissionScope Read v3 catalog
3816
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
3817
+ * @permissionScope Manage Products
3818
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
3819
+ * @permissionScope Read Stores - all read permissions
3820
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3821
+ * @permissionScope Read Products
3822
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
3823
+ * @permissionScope Manage Restaurants - all permissions
3824
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3825
+ * @permissionScope Manage v3 catalog
3826
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
3827
+ * @permissionScope Manage Orders
3828
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3829
+ * @permissionId CATEGORIES.CATEGORY_READ
3830
+ * @webhook
3831
+ * @eventType wix.categories.v1.category_category_moved
3832
+ * @slug category_moved
3833
+ */
3834
+ declare function onCategoryMoved(handler: (event: CategoryMovedEnvelope) => void | Promise<void>): void;
3538
3835
  interface CategoryCreatedEnvelope {
3539
3836
  entity: Category;
3540
3837
  metadata: EventMetadata;
3541
3838
  }
3839
+ /** @permissionScope Manage Stores - all permissions
3840
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3841
+ * @permissionScope Manage Stores
3842
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3843
+ * @permissionScope Read categories
3844
+ * @permissionScopeId SCOPE.CATEGORIES.CATEGORY_READ
3845
+ * @permissionScope Read v3 catalog
3846
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
3847
+ * @permissionScope Manage Products
3848
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
3849
+ * @permissionScope Read Stores - all read permissions
3850
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3851
+ * @permissionScope Read Products
3852
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
3853
+ * @permissionScope Manage Restaurants - all permissions
3854
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3855
+ * @permissionScope Manage v3 catalog
3856
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
3857
+ * @permissionScope Manage Orders
3858
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3859
+ * @permissionId CATEGORIES.CATEGORY_READ
3860
+ * @webhook
3861
+ * @eventType wix.categories.v1.category_created
3862
+ * @slug created
3863
+ */
3864
+ declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
3542
3865
  interface CategoryDeletedEnvelope {
3543
3866
  metadata: EventMetadata;
3544
3867
  }
3868
+ /** @permissionScope Manage Stores - all permissions
3869
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3870
+ * @permissionScope Manage Stores
3871
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3872
+ * @permissionScope Read categories
3873
+ * @permissionScopeId SCOPE.CATEGORIES.CATEGORY_READ
3874
+ * @permissionScope Read v3 catalog
3875
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
3876
+ * @permissionScope Manage Products
3877
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
3878
+ * @permissionScope Read Stores - all read permissions
3879
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3880
+ * @permissionScope Read Products
3881
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
3882
+ * @permissionScope Manage Restaurants - all permissions
3883
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3884
+ * @permissionScope Manage v3 catalog
3885
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
3886
+ * @permissionScope Manage Orders
3887
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3888
+ * @permissionId CATEGORIES.CATEGORY_READ
3889
+ * @webhook
3890
+ * @eventType wix.categories.v1.category_deleted
3891
+ * @slug deleted
3892
+ */
3893
+ declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
3545
3894
  interface CategoryItemAddedToCategoryEnvelope {
3546
3895
  data: ItemAddedToCategory;
3547
3896
  metadata: EventMetadata;
3548
3897
  }
3898
+ /**
3899
+ * Triggered when an item is added to a category.
3900
+ * @permissionScope Manage Stores - all permissions
3901
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3902
+ * @permissionScope Manage Stores
3903
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3904
+ * @permissionScope Read categories
3905
+ * @permissionScopeId SCOPE.CATEGORIES.CATEGORY_READ
3906
+ * @permissionScope Read v3 catalog
3907
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
3908
+ * @permissionScope Manage Products
3909
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
3910
+ * @permissionScope Read Stores - all read permissions
3911
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3912
+ * @permissionScope Read Products
3913
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
3914
+ * @permissionScope Manage Restaurants - all permissions
3915
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3916
+ * @permissionScope Manage v3 catalog
3917
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
3918
+ * @permissionScope Manage Orders
3919
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3920
+ * @permissionId CATEGORIES.CATEGORY_READ
3921
+ * @webhook
3922
+ * @eventType wix.categories.v1.category_item_added_to_category
3923
+ * @slug item_added_to_category
3924
+ */
3925
+ declare function onCategoryItemAddedToCategory(handler: (event: CategoryItemAddedToCategoryEnvelope) => void | Promise<void>): void;
3549
3926
  interface CategoryItemRemovedFromCategoryEnvelope {
3550
3927
  data: ItemRemovedFromCategory;
3551
3928
  metadata: EventMetadata;
3552
3929
  }
3930
+ /**
3931
+ * Triggered when an item is removed from a category.
3932
+ * @permissionScope Manage Stores - all permissions
3933
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3934
+ * @permissionScope Manage Stores
3935
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3936
+ * @permissionScope Read categories
3937
+ * @permissionScopeId SCOPE.CATEGORIES.CATEGORY_READ
3938
+ * @permissionScope Read v3 catalog
3939
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
3940
+ * @permissionScope Manage Products
3941
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
3942
+ * @permissionScope Read Stores - all read permissions
3943
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3944
+ * @permissionScope Read Products
3945
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
3946
+ * @permissionScope Manage Restaurants - all permissions
3947
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3948
+ * @permissionScope Manage v3 catalog
3949
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
3950
+ * @permissionScope Manage Orders
3951
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3952
+ * @permissionId CATEGORIES.CATEGORY_READ
3953
+ * @webhook
3954
+ * @eventType wix.categories.v1.category_item_removed_from_category
3955
+ * @slug item_removed_from_category
3956
+ */
3957
+ declare function onCategoryItemRemovedFromCategory(handler: (event: CategoryItemRemovedFromCategoryEnvelope) => void | Promise<void>): void;
3553
3958
  interface CategoryItemsArrangedInCategoryEnvelope {
3554
3959
  data: ItemsArrangedInCategory;
3555
3960
  metadata: EventMetadata;
3556
3961
  }
3962
+ /**
3963
+ * Triggered when items arrangement in category is changed.
3964
+ * @permissionScope Manage Stores - all permissions
3965
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3966
+ * @permissionScope Manage Stores
3967
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3968
+ * @permissionScope Read categories
3969
+ * @permissionScopeId SCOPE.CATEGORIES.CATEGORY_READ
3970
+ * @permissionScope Read v3 catalog
3971
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
3972
+ * @permissionScope Manage Products
3973
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
3974
+ * @permissionScope Read Stores - all read permissions
3975
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3976
+ * @permissionScope Read Products
3977
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
3978
+ * @permissionScope Manage Restaurants - all permissions
3979
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3980
+ * @permissionScope Manage v3 catalog
3981
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
3982
+ * @permissionScope Manage Orders
3983
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3984
+ * @permissionId CATEGORIES.CATEGORY_READ
3985
+ * @webhook
3986
+ * @eventType wix.categories.v1.category_items_arranged_in_category
3987
+ * @slug items_arranged_in_category
3988
+ */
3989
+ declare function onCategoryItemsArrangedInCategory(handler: (event: CategoryItemsArrangedInCategoryEnvelope) => void | Promise<void>): void;
3557
3990
  interface CategoryUpdatedEnvelope {
3558
3991
  entity: Category;
3559
3992
  metadata: EventMetadata;
3560
3993
  }
3994
+ /** @permissionScope Manage Stores - all permissions
3995
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3996
+ * @permissionScope Manage Stores
3997
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3998
+ * @permissionScope Read categories
3999
+ * @permissionScopeId SCOPE.CATEGORIES.CATEGORY_READ
4000
+ * @permissionScope Read v3 catalog
4001
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
4002
+ * @permissionScope Manage Products
4003
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
4004
+ * @permissionScope Read Stores - all read permissions
4005
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
4006
+ * @permissionScope Read Products
4007
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
4008
+ * @permissionScope Manage Restaurants - all permissions
4009
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4010
+ * @permissionScope Manage v3 catalog
4011
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
4012
+ * @permissionScope Manage Orders
4013
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
4014
+ * @permissionId CATEGORIES.CATEGORY_READ
4015
+ * @webhook
4016
+ * @eventType wix.categories.v1.category_updated
4017
+ * @slug updated
4018
+ */
4019
+ declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) => void | Promise<void>): void;
4020
+ type CategoryNonNullablePaths = `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug`;
4021
+ /**
4022
+ * Creates a category.
4023
+ * @param category - Category to create.
4024
+ * @public
4025
+ * @requiredField category
4026
+ * @requiredField category.name
4027
+ * @requiredField category.parentCategory._id
4028
+ * @requiredField options.treeReference
4029
+ * @requiredField options.treeReference.appNamespace
4030
+ * @permissionId CATEGORIES.CATEGORY_CREATE
4031
+ * @applicableIdentity APP
4032
+ * @returns Created category.
4033
+ * @fqn com.wix.categories.api.v1.CategoriesService.CreateCategory
4034
+ */
4035
+ declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<Category, CategoryNonNullablePaths> & {
4036
+ __applicationErrorsType?: CreateCategoryApplicationErrors;
4037
+ }>;
3561
4038
  interface CreateCategoryOptions {
3562
4039
  /** Category tree reference details. */
3563
4040
  treeReference: TreeReference;
@@ -3567,6 +4044,21 @@ interface CreateCategoryOptions {
3567
4044
  */
3568
4045
  fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
3569
4046
  }
4047
+ /**
4048
+ * Retrieves a category.
4049
+ * @param categoryId - Category ID.
4050
+ * @param treeReference - Category tree reference details.
4051
+ * @public
4052
+ * @requiredField categoryId
4053
+ * @requiredField treeReference
4054
+ * @requiredField treeReference.appNamespace
4055
+ * @permissionId CATEGORIES.CATEGORY_READ
4056
+ * @applicableIdentity APP
4057
+ * @applicableIdentity VISITOR
4058
+ * @returns Category.
4059
+ * @fqn com.wix.categories.api.v1.CategoriesService.GetCategory
4060
+ */
4061
+ declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
3570
4062
  interface GetCategoryOptions {
3571
4063
  /**
3572
4064
  * Fields to include in the response.
@@ -3574,6 +4066,27 @@ interface GetCategoryOptions {
3574
4066
  */
3575
4067
  fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
3576
4068
  }
4069
+ /**
4070
+ * Updates a category.
4071
+ *
4072
+ * Each time the category is updated, `revision` increments by 1.
4073
+ * The current `revision` must be passed when updating the category.
4074
+ * This ensures you're working with the latest category and prevents unintended overwrites.
4075
+ * @param _id - Category ID.
4076
+ * @public
4077
+ * @requiredField _id
4078
+ * @requiredField category
4079
+ * @requiredField category.revision
4080
+ * @requiredField options.treeReference
4081
+ * @requiredField options.treeReference.appNamespace
4082
+ * @permissionId CATEGORIES.CATEGORY_UPDATE
4083
+ * @applicableIdentity APP
4084
+ * @returns Updated category.
4085
+ * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategory
4086
+ */
4087
+ declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<Category, CategoryNonNullablePaths> & {
4088
+ __applicationErrorsType?: UpdateCategoryApplicationErrors;
4089
+ }>;
3577
4090
  interface UpdateCategory {
3578
4091
  /**
3579
4092
  * Category ID.
@@ -3685,6 +4198,38 @@ interface UpdateCategoryOptions {
3685
4198
  */
3686
4199
  fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
3687
4200
  }
4201
+ /**
4202
+ * Deletes a category.
4203
+ * @param categoryId - Category ID.
4204
+ * @param treeReference - Category tree reference details.
4205
+ * @public
4206
+ * @requiredField categoryId
4207
+ * @requiredField treeReference
4208
+ * @requiredField treeReference.appNamespace
4209
+ * @permissionId CATEGORIES.CATEGORY_DELETE
4210
+ * @applicableIdentity APP
4211
+ * @fqn com.wix.categories.api.v1.CategoriesService.DeleteCategory
4212
+ */
4213
+ declare function deleteCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>): Promise<void & {
4214
+ __applicationErrorsType?: DeleteCategoryApplicationErrors;
4215
+ }>;
4216
+ /**
4217
+ * Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.
4218
+ * Pass supported values to the `fields` array in the request to include those fields in the response.
4219
+ *
4220
+ * For field support for filters and sorting,
4221
+ * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
4222
+ *
4223
+ * To learn about working with _Query_ endpoints, see
4224
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
4225
+ * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
4226
+ * @public
4227
+ * @permissionId CATEGORIES.CATEGORY_READ
4228
+ * @applicableIdentity APP
4229
+ * @applicableIdentity VISITOR
4230
+ * @fqn com.wix.categories.api.v1.CategoriesService.QueryCategories
4231
+ */
4232
+ declare function queryCategories(options: QueryCategoriesOptions): CategoriesQueryBuilder;
3688
4233
  interface QueryCategoriesOptions {
3689
4234
  /** Category tree reference details. */
3690
4235
  treeReference: TreeReference;
@@ -3716,70 +4261,49 @@ interface CategoriesQueryResult extends QueryCursorResult {
3716
4261
  interface CategoriesQueryBuilder {
3717
4262
  /** @param propertyName - Property whose value is compared with `value`.
3718
4263
  * @param value - Value to compare against.
3719
- * @documentationMaturity preview
3720
4264
  */
3721
4265
  eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3722
4266
  /** @param propertyName - Property whose value is compared with `value`.
3723
4267
  * @param value - Value to compare against.
3724
- * @documentationMaturity preview
3725
4268
  */
3726
4269
  ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3727
4270
  /** @param propertyName - Property whose value is compared with `value`.
3728
4271
  * @param value - Value to compare against.
3729
- * @documentationMaturity preview
3730
4272
  */
3731
4273
  ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3732
4274
  /** @param propertyName - Property whose value is compared with `value`.
3733
4275
  * @param value - Value to compare against.
3734
- * @documentationMaturity preview
3735
4276
  */
3736
4277
  gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3737
4278
  /** @param propertyName - Property whose value is compared with `value`.
3738
4279
  * @param value - Value to compare against.
3739
- * @documentationMaturity preview
3740
4280
  */
3741
4281
  le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3742
4282
  /** @param propertyName - Property whose value is compared with `value`.
3743
4283
  * @param value - Value to compare against.
3744
- * @documentationMaturity preview
3745
4284
  */
3746
4285
  lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3747
4286
  /** @param propertyName - Property whose value is compared with `string`.
3748
4287
  * @param string - String to compare against. Case-insensitive.
3749
- * @documentationMaturity preview
3750
4288
  */
3751
4289
  startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: string) => CategoriesQueryBuilder;
3752
4290
  /** @param propertyName - Property whose value is compared with `values`.
3753
4291
  * @param values - List of values to compare against.
3754
- * @documentationMaturity preview
3755
4292
  */
3756
4293
  hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
3757
- /** @documentationMaturity preview */
3758
4294
  in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3759
- /** @documentationMaturity preview */
3760
4295
  exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
3761
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3762
- * @documentationMaturity preview
3763
- */
4296
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3764
4297
  ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
3765
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3766
- * @documentationMaturity preview
3767
- */
4298
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3768
4299
  descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
3769
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
3770
- * @documentationMaturity preview
3771
- */
4300
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
3772
4301
  limit: (limit: number) => CategoriesQueryBuilder;
3773
- /** @param cursor - A pointer to specific record
3774
- * @documentationMaturity preview
3775
- */
4302
+ /** @param cursor - A pointer to specific record */
3776
4303
  skipTo: (cursor: string) => CategoriesQueryBuilder;
3777
- /** @documentationMaturity preview */
3778
4304
  find: () => Promise<CategoriesQueryResult>;
3779
4305
  }
3780
4306
  interface SearchCategoriesOptions {
3781
- /** Search options. */
3782
- search?: CursorSearch;
3783
4307
  /**
3784
4308
  * Category tree reference details.
3785
4309
  * > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
@@ -3797,6 +4321,180 @@ interface SearchCategoriesOptions {
3797
4321
  */
3798
4322
  fields?: RequestedFieldsWithLiterals[];
3799
4323
  }
4324
+ interface CategorySearchSpec extends SearchSpec {
4325
+ searchable: ['description', 'name'];
4326
+ aggregatable: [
4327
+ '_createdDate',
4328
+ '_id',
4329
+ '_updatedDate',
4330
+ 'managingAppId',
4331
+ 'name',
4332
+ 'parentCategory._id',
4333
+ 'parentCategory.index',
4334
+ 'slug',
4335
+ 'treeReference.appNamespace',
4336
+ 'treeReference.treeKey',
4337
+ 'visible'
4338
+ ];
4339
+ paging: 'cursor';
4340
+ wql: [
4341
+ {
4342
+ operators: '*';
4343
+ fields: [
4344
+ '_id',
4345
+ 'slug',
4346
+ 'treeReference.appNamespace',
4347
+ 'treeReference.treeKey',
4348
+ 'visible'
4349
+ ];
4350
+ sort: 'NONE';
4351
+ },
4352
+ {
4353
+ operators: '*';
4354
+ fields: [
4355
+ '_createdDate',
4356
+ '_updatedDate',
4357
+ 'managingAppId',
4358
+ 'name',
4359
+ 'parentCategory._id',
4360
+ 'parentCategory.index'
4361
+ ];
4362
+ sort: 'BOTH';
4363
+ }
4364
+ ];
4365
+ }
4366
+ type CommonSearchWithEntityContext = Search<Category, CategorySearchSpec>;
4367
+ type CategorySearch = {
4368
+ /**
4369
+ Cursor pointing to page of results.
4370
+ When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
4371
+ */
4372
+ cursorPaging?: {
4373
+ /**
4374
+ Maximum number of items to return in the results.
4375
+ @max: 1000
4376
+ */
4377
+ limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
4378
+ /**
4379
+ Pointer to the next or previous page in the list of results.
4380
+
4381
+ Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
4382
+ Not relevant for the first request.
4383
+ @maxLength: 16000
4384
+ */
4385
+ cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
4386
+ };
4387
+ /**
4388
+ A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
4389
+ */
4390
+ filter?: CommonSearchWithEntityContext['filter'] | null;
4391
+ /**
4392
+ Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4393
+ @maxSize: 10
4394
+ */
4395
+ sort?: {
4396
+ /**
4397
+ Name of the field to sort by.
4398
+ @maxLength: 512
4399
+ */
4400
+ fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
4401
+ /**
4402
+ Sort order.
4403
+ */
4404
+ order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
4405
+ }[];
4406
+ /**
4407
+ Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
4408
+ @maxSize: 10
4409
+ */
4410
+ aggregations?: {
4411
+ /**
4412
+ Value aggregation
4413
+ */
4414
+ value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
4415
+ /**
4416
+ Range aggregation
4417
+ */
4418
+ range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
4419
+ /**
4420
+ Scalar aggregation
4421
+ */
4422
+ scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
4423
+ /**
4424
+ Date histogram aggregation
4425
+ */
4426
+ dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
4427
+ /**
4428
+ Nested aggregation
4429
+ */
4430
+ nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
4431
+ /**
4432
+ User-defined name of aggregation, should be unique, will appear in aggregation results
4433
+ @maxLength: 100
4434
+ */
4435
+ name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
4436
+ /**
4437
+ Type of aggregation, client must provide matching aggregation field below
4438
+ */
4439
+ type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
4440
+ /**
4441
+ Field to aggregate by, use dot notation to specify json path
4442
+ @maxLength: 200
4443
+ */
4444
+ fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
4445
+ }[];
4446
+ /**
4447
+ Free text to match in searchable fields
4448
+ */
4449
+ search?: {
4450
+ /**
4451
+ Defines how separate search terms in `expression` are combined.
4452
+ */
4453
+ mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
4454
+ /**
4455
+ Search term or expression.
4456
+ @maxLength: 100
4457
+ */
4458
+ expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
4459
+ /**
4460
+ Fields in which to search for the `expression`. Use dot notation to specify field path.
4461
+
4462
+ When empty - all searchable fields are looked at.
4463
+ @maxLength: 200,
4464
+ @maxSize: 20
4465
+ */
4466
+ fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
4467
+ /**
4468
+ Whether to use fuzzy search - allowing typos and other minor errors in the search.
4469
+ */
4470
+ fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
4471
+ };
4472
+ /**
4473
+ UTC offset or IANA time zone. Valid values are
4474
+ ISO 8601 UTC offsets, such as +02:00 or -06:00,
4475
+ and IANA time zone IDs, such as Europe/Rome
4476
+
4477
+ Affects all filters and aggregations returned values.
4478
+ You may override this behavior in a specific filter by providing
4479
+ timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
4480
+ @maxLength: 50
4481
+ */
4482
+ timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
4483
+ };
4484
+ /**
4485
+ * Counts the number of categories that match the provided filtering.
4486
+ *
4487
+ * For field support for filters and sorting,
4488
+ * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
4489
+ * @public
4490
+ * @requiredField options.treeReference
4491
+ * @requiredField options.treeReference.appNamespace
4492
+ * @permissionId CATEGORIES.CATEGORY_READ
4493
+ * @applicableIdentity APP
4494
+ * @applicableIdentity VISITOR
4495
+ * @fqn com.wix.categories.api.v1.CategoriesService.CountCategories
4496
+ */
4497
+ declare function countCategories(options?: NonNullablePaths<CountCategoriesOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<CountCategoriesResponse, `count`>>;
3800
4498
  interface CountCategoriesOptions {
3801
4499
  /**
3802
4500
  * Filter object.
@@ -3815,6 +4513,22 @@ interface CountCategoriesOptions {
3815
4513
  */
3816
4514
  returnNonVisibleCategories?: boolean;
3817
4515
  }
4516
+ /**
4517
+ * Moves a category within its parent category, or to a different parent category.
4518
+ * @param categoryId - ID of the category to move.
4519
+ * @param treeReference - Category tree reference details.
4520
+ * @public
4521
+ * @requiredField categoryId
4522
+ * @requiredField options.position
4523
+ * @requiredField treeReference
4524
+ * @requiredField treeReference.appNamespace
4525
+ * @permissionId CATEGORIES.CATEGORY_MOVE
4526
+ * @applicableIdentity APP
4527
+ * @fqn com.wix.categories.api.v1.CategoriesService.MoveCategory
4528
+ */
4529
+ declare function moveCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: NonNullablePaths<MoveCategoryOptions, `position`>): Promise<NonNullablePaths<MoveCategoryResponse, `categoriesAfterMove`> & {
4530
+ __applicationErrorsType?: MoveCategoryApplicationErrors;
4531
+ }>;
3818
4532
  interface MoveCategoryOptions {
3819
4533
  /**
3820
4534
  * Parent category ID.
@@ -3837,6 +4551,29 @@ interface MoveCategoryOptions {
3837
4551
  */
3838
4552
  moveAfterCategoryId?: string | null;
3839
4553
  }
4554
+ /**
4555
+ * Updates multiple categories.
4556
+ *
4557
+ * Each time a category is updated, `revision` increments by 1.
4558
+ * The current `revision` must be passed when updating a category.
4559
+ * This ensures you're working with the latest category and prevents unintended overwrites.
4560
+ * @param categories - List of categories to update.
4561
+ * @public
4562
+ * @requiredField categories
4563
+ * @requiredField categories.category
4564
+ * @requiredField categories.category._id
4565
+ * @requiredField categories.category.revision
4566
+ * @requiredField options.treeReference
4567
+ * @requiredField options.treeReference.appNamespace
4568
+ * @permissionId CATEGORIES.CATEGORY_UPDATE
4569
+ * @applicableIdentity APP
4570
+ * @fqn com.wix.categories.api.v1.CategoriesService.BulkUpdateCategories
4571
+ */
4572
+ declare function bulkUpdateCategories(categories: NonNullablePaths<MaskedCategory, `category` | `category._id` | `category.revision`>[], options?: NonNullablePaths<BulkUpdateCategoriesOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<BulkUpdateCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
4573
+ [P in CategoryNonNullablePaths]: `results.${number}.category.${P}`;
4574
+ }[CategoryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
4575
+ __applicationErrorsType?: BulkUpdateCategoriesApplicationErrors;
4576
+ }>;
3840
4577
  interface BulkUpdateCategoriesOptions {
3841
4578
  /** Category tree reference details. */
3842
4579
  treeReference: TreeReference;
@@ -3852,6 +4589,29 @@ interface BulkUpdateCategoriesOptions {
3852
4589
  */
3853
4590
  fields?: RequestedFieldsWithLiterals[];
3854
4591
  }
4592
+ /**
4593
+ * Updates category visibility.
4594
+ *
4595
+ *
4596
+ * Each time a category is updated, `revision` increments by 1.
4597
+ * The current `revision` must be passed when updating a category.
4598
+ * This ensures you're working with the latest category and prevents unintended overwrites.
4599
+ * @param categoryId - Category ID.
4600
+ * @public
4601
+ * @requiredField categoryId
4602
+ * @requiredField options.revision
4603
+ * @requiredField options.treeReference
4604
+ * @requiredField options.treeReference.appNamespace
4605
+ * @requiredField options.visible
4606
+ * @permissionId CATEGORIES.CATEGORY_UPDATE
4607
+ * @applicableIdentity APP
4608
+ * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategoryVisibility
4609
+ */
4610
+ declare function updateCategoryVisibility(categoryId: string, options?: NonNullablePaths<UpdateCategoryVisibilityOptions, `revision` | `treeReference` | `treeReference.appNamespace` | `visible`>): Promise<NonNullablePaths<UpdateCategoryVisibilityResponse, {
4611
+ [P in CategoryNonNullablePaths]: `category.${P}`;
4612
+ }[CategoryNonNullablePaths]> & {
4613
+ __applicationErrorsType?: UpdateCategoryVisibilityApplicationErrors;
4614
+ }>;
3855
4615
  interface UpdateCategoryVisibilityOptions {
3856
4616
  /**
3857
4617
  * Whether the category is visible to site visitors in dynamic pages.
@@ -3873,6 +4633,23 @@ interface UpdateCategoryVisibilityOptions {
3873
4633
  */
3874
4634
  fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
3875
4635
  }
4636
+ /**
4637
+ * Updates the visibility of multiple categories so that they are visible to site visitors in dynamic pages.
4638
+ *
4639
+ * Calling this method sets each category's `visible` field to `true`.
4640
+ * > **Note:** If one of the passed categories has a parent category that is not visible, the passed category will not be updated.
4641
+ * @param categoryIds - IDs of the categories to update.
4642
+ * @public
4643
+ * @requiredField categoryIds
4644
+ * @requiredField options.treeReference
4645
+ * @requiredField options.treeReference.appNamespace
4646
+ * @permissionId CATEGORIES.CATEGORY_UPDATE
4647
+ * @applicableIdentity APP
4648
+ * @fqn com.wix.categories.api.v1.CategoriesService.BulkShowCategories
4649
+ */
4650
+ declare function bulkShowCategories(categoryIds: string[], options?: NonNullablePaths<BulkShowCategoriesOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<BulkShowCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
4651
+ [P in CategoryNonNullablePaths]: `results.${number}.category.${P}`;
4652
+ }[CategoryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
3876
4653
  interface BulkShowCategoriesOptions {
3877
4654
  /** Category tree reference details. */
3878
4655
  treeReference: TreeReference;
@@ -3888,10 +4665,47 @@ interface BulkShowCategoriesOptions {
3888
4665
  */
3889
4666
  fields?: RequestedFieldsWithLiterals[];
3890
4667
  }
4668
+ /**
4669
+ * Adds multiple items to a single category.
4670
+ * @param categoryId - Category ID.
4671
+ * @param items - List of items to add.
4672
+ * @public
4673
+ * @requiredField categoryId
4674
+ * @requiredField items
4675
+ * @requiredField items.appId
4676
+ * @requiredField items.catalogItemId
4677
+ * @requiredField options
4678
+ * @requiredField options.treeReference
4679
+ * @requiredField options.treeReference.appNamespace
4680
+ * @permissionId CATEGORIES.CATEGORY_ADD_ITEM
4681
+ * @applicableIdentity APP
4682
+ * @fqn com.wix.categories.api.v1.CategoriesService.BulkAddItemsToCategory
4683
+ */
4684
+ declare function bulkAddItemsToCategory(categoryId: string, items: NonNullablePaths<ItemReference, `appId` | `catalogItemId`>[], options: NonNullablePaths<BulkAddItemsToCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<BulkAddItemsToCategoryResponse, `results` | `results.${number}.itemMetadata.item.catalogItemId` | `results.${number}.itemMetadata.item.appId` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
4685
+ __applicationErrorsType?: BulkAddItemsToCategoryApplicationErrors;
4686
+ }>;
3891
4687
  interface BulkAddItemsToCategoryOptions {
3892
4688
  /** Category tree reference details. */
3893
4689
  treeReference: TreeReference;
3894
4690
  }
4691
+ /**
4692
+ * Adds a single item to multiple categories.
4693
+ * @param item - Item to add.
4694
+ * @public
4695
+ * @requiredField item
4696
+ * @requiredField item.appId
4697
+ * @requiredField item.catalogItemId
4698
+ * @requiredField options
4699
+ * @requiredField options.categoryIds
4700
+ * @requiredField options.treeReference
4701
+ * @requiredField options.treeReference.appNamespace
4702
+ * @permissionId CATEGORIES.CATEGORY_ADD_ITEM
4703
+ * @applicableIdentity APP
4704
+ * @fqn com.wix.categories.api.v1.CategoriesService.BulkAddItemToCategories
4705
+ */
4706
+ declare function bulkAddItemToCategories(item: NonNullablePaths<ItemReference, `appId` | `catalogItemId`>, options: NonNullablePaths<BulkAddItemToCategoriesOptions, `categoryIds` | `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<BulkAddItemToCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
4707
+ __applicationErrorsType?: BulkAddItemToCategoriesApplicationErrors;
4708
+ }>;
3895
4709
  interface BulkAddItemToCategoriesOptions {
3896
4710
  /**
3897
4711
  * IDs of categories to which to add the item.
@@ -3903,10 +4717,47 @@ interface BulkAddItemToCategoriesOptions {
3903
4717
  /** Category tree reference details. */
3904
4718
  treeReference: TreeReference;
3905
4719
  }
4720
+ /**
4721
+ * Removes multiple items from a single category.
4722
+ * @param categoryId - Category ID.
4723
+ * @param items - List of items to remove.
4724
+ * @public
4725
+ * @requiredField categoryId
4726
+ * @requiredField items
4727
+ * @requiredField items.appId
4728
+ * @requiredField items.catalogItemId
4729
+ * @requiredField options
4730
+ * @requiredField options.treeReference
4731
+ * @requiredField options.treeReference.appNamespace
4732
+ * @permissionId CATEGORIES.CATEGORY_REMOVE_ITEM
4733
+ * @applicableIdentity APP
4734
+ * @fqn com.wix.categories.api.v1.CategoriesService.BulkRemoveItemsFromCategory
4735
+ */
4736
+ declare function bulkRemoveItemsFromCategory(categoryId: string, items: NonNullablePaths<ItemReference, `appId` | `catalogItemId`>[], options: NonNullablePaths<BulkRemoveItemsFromCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<BulkRemoveItemsFromCategoryResponse, `results` | `results.${number}.itemMetadata.item.catalogItemId` | `results.${number}.itemMetadata.item.appId` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
4737
+ __applicationErrorsType?: BulkRemoveItemsFromCategoryApplicationErrors;
4738
+ }>;
3906
4739
  interface BulkRemoveItemsFromCategoryOptions {
3907
4740
  /** Category tree reference details. */
3908
4741
  treeReference: TreeReference;
3909
4742
  }
4743
+ /**
4744
+ * Removes a single item from multiple categories.
4745
+ * @param item - Item to remove.
4746
+ * @public
4747
+ * @requiredField item
4748
+ * @requiredField item.appId
4749
+ * @requiredField item.catalogItemId
4750
+ * @requiredField options
4751
+ * @requiredField options.categoryIds
4752
+ * @requiredField options.treeReference
4753
+ * @requiredField options.treeReference.appNamespace
4754
+ * @permissionId CATEGORIES.CATEGORY_REMOVE_ITEM
4755
+ * @applicableIdentity APP
4756
+ * @fqn com.wix.categories.api.v1.CategoriesService.BulkRemoveItemFromCategories
4757
+ */
4758
+ declare function bulkRemoveItemFromCategories(item: NonNullablePaths<ItemReference, `appId` | `catalogItemId`>, options: NonNullablePaths<BulkRemoveItemFromCategoriesOptions, `categoryIds` | `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<BulkRemoveItemFromCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
4759
+ __applicationErrorsType?: BulkRemoveItemFromCategoriesApplicationErrors;
4760
+ }>;
3910
4761
  interface BulkRemoveItemFromCategoriesOptions {
3911
4762
  /**
3912
4763
  * IDs of categories from which to remove the item.
@@ -3918,6 +4769,23 @@ interface BulkRemoveItemFromCategoriesOptions {
3918
4769
  /** Category tree reference details. */
3919
4770
  treeReference: TreeReference;
3920
4771
  }
4772
+ /**
4773
+ * Retrieves a list of up to 100 items from a single category, given the provided cursor paging.
4774
+ *
4775
+ *
4776
+ * List Items In Categories defaults to sorting by the time the item was added to the category, in descending order.
4777
+ * @param categoryId - Category ID.
4778
+ * @param treeReference - Category tree reference details.
4779
+ * @public
4780
+ * @requiredField categoryId
4781
+ * @requiredField treeReference
4782
+ * @requiredField treeReference.appNamespace
4783
+ * @permissionId CATEGORIES.CATEGORY_READ
4784
+ * @applicableIdentity APP
4785
+ * @applicableIdentity VISITOR
4786
+ * @fqn com.wix.categories.api.v1.CategoriesService.ListItemsInCategory
4787
+ */
4788
+ declare function listItemsInCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: ListItemsInCategoryOptions): Promise<NonNullablePaths<ListItemsInCategoryResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`>>;
3921
4789
  interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMethodOneOf {
3922
4790
  /**
3923
4791
  * Whether to use category arrangement for sorting items.
@@ -3947,14 +4815,71 @@ interface ListItemsInCategoryOptionsPagingMethodOneOf {
3947
4815
  */
3948
4816
  cursorPaging?: CursorPaging;
3949
4817
  }
4818
+ /**
4819
+ * Retrieves a list of categories that contain the specified item.
4820
+ * @param item - Item reference info.
4821
+ * @public
4822
+ * @requiredField item
4823
+ * @requiredField options
4824
+ * @requiredField options.treeReference
4825
+ * @requiredField options.treeReference.appNamespace
4826
+ * @permissionId CATEGORIES.CATEGORY_READ
4827
+ * @applicableIdentity APP
4828
+ * @applicableIdentity VISITOR
4829
+ * @fqn com.wix.categories.api.v1.CategoriesService.ListCategoriesForItem
4830
+ */
4831
+ declare function listCategoriesForItem(item: ItemReference, options: NonNullablePaths<ListCategoriesForItemOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<ListCategoriesForItemResponse, `directCategoryIds` | `allCategoryIds`>>;
3950
4832
  interface ListCategoriesForItemOptions {
3951
4833
  /** Category tree reference details. */
3952
4834
  treeReference: TreeReference;
3953
4835
  }
4836
+ /**
4837
+ * Retrieves a map where the keys are ItemReferences, and the values are lists of categories that contain the corresponding item.
4838
+ * @param items - List of Item reference info.
4839
+ * @public
4840
+ * @requiredField items
4841
+ * @requiredField items.appId
4842
+ * @requiredField items.catalogItemId
4843
+ * @requiredField options
4844
+ * @requiredField options.treeReference
4845
+ * @requiredField options.treeReference.appNamespace
4846
+ * @permissionId CATEGORIES.CATEGORY_READ
4847
+ * @applicableIdentity APP
4848
+ * @applicableIdentity VISITOR
4849
+ * @fqn com.wix.categories.api.v1.CategoriesService.ListCategoriesForItems
4850
+ */
4851
+ declare function listCategoriesForItems(items: NonNullablePaths<ItemReference, `appId` | `catalogItemId`>[], options: NonNullablePaths<ListCategoriesForItemsOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<ListCategoriesForItemsResponse, `categoriesForItems` | `categoriesForItems.${number}.item.catalogItemId` | `categoriesForItems.${number}.item.appId`>>;
3954
4852
  interface ListCategoriesForItemsOptions {
3955
4853
  /** Category tree reference details. */
3956
4854
  treeReference: TreeReference;
3957
4855
  }
4856
+ /**
4857
+ * Retrieves a list of all trees installed on the site, sorted by `appNamespace` in ascending order.
4858
+ * @public
4859
+ * @permissionId CATEGORIES.CATEGORY_READ
4860
+ * @applicableIdentity APP
4861
+ * @applicableIdentity VISITOR
4862
+ * @fqn com.wix.categories.api.v1.CategoriesService.ListTrees
4863
+ */
4864
+ declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees` | `trees.${number}.appNamespace`>>;
4865
+ /**
4866
+ * Sets arranged items in a category.
4867
+ *
4868
+ * The order of items in the `items` array determines the order of items in the category.
4869
+ * The category's existing list of arranged items will be overridden.
4870
+ * @param categoryId - Category ID.
4871
+ * @param treeReference - Category tree reference details.
4872
+ * @public
4873
+ * @requiredField categoryId
4874
+ * @requiredField treeReference
4875
+ * @requiredField treeReference.appNamespace
4876
+ * @permissionId CATEGORIES.CATEGORY_MOVE_ITEM
4877
+ * @applicableIdentity APP
4878
+ * @fqn com.wix.categories.api.v1.CategoriesService.SetArrangedItems
4879
+ */
4880
+ declare function setArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: SetArrangedItemsOptions): Promise<NonNullablePaths<SetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`> & {
4881
+ __applicationErrorsType?: SetArrangedItemsApplicationErrors;
4882
+ }>;
3958
4883
  interface SetArrangedItemsOptions {
3959
4884
  /**
3960
4885
  * List of items to set.
@@ -3962,5 +4887,19 @@ interface SetArrangedItemsOptions {
3962
4887
  */
3963
4888
  items?: ItemReference[];
3964
4889
  }
4890
+ /**
4891
+ * Retrieves a list of arranged items in a category.
4892
+ * @param categoryId - Category ID.
4893
+ * @param treeReference - Category tree reference details.
4894
+ * @public
4895
+ * @requiredField categoryId
4896
+ * @requiredField treeReference
4897
+ * @requiredField treeReference.appNamespace
4898
+ * @permissionId CATEGORIES.CATEGORY_READ
4899
+ * @applicableIdentity APP
4900
+ * @applicableIdentity VISITOR
4901
+ * @fqn com.wix.categories.api.v1.CategoriesService.GetArrangedItems
4902
+ */
4903
+ declare function getArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>): Promise<NonNullablePaths<GetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`>>;
3965
4904
 
3966
- export { LineStyle as $, type ListTreesResponse as A, type BulkUpdateCategoriesOptions as B, type Category as C, type SetArrangedItemsOptions as D, type SetArrangedItemsResponse as E, type GetArrangedItemsResponse as F, type GetCategoryOptions as G, type CategoryMovedEnvelope as H, type ItemReference as I, type CategoryCreatedEnvelope as J, type CategoryDeletedEnvelope as K, type ListItemsInCategoryOptions as L, type MoveCategoryOptions as M, type CategoryItemAddedToCategoryEnvelope as N, type CategoryItemRemovedFromCategoryEnvelope as O, type CategoryItemsArrangedInCategoryEnvelope as P, type QueryCategoriesOptions as Q, type CategoryUpdatedEnvelope as R, type SearchCategoriesOptions as S, type TreeReference as T, type UpdateCategory as U, NodeType as V, WidthType as W, PluginContainerDataAlignment as X, Type as Y, Target as Z, TextAlignment as _, type CreateCategoryOptions as a, type FileData as a$, Width as a0, Alignment as a1, ViewMode as a2, LayoutType as a3, Orientation as a4, Crop as a5, ThumbnailsAlignment as a6, GIFType as a7, Source as a8, StylesPosition as a9, WebhookIdentityType as aA, type BreadcrumbsInfo as aB, type Breadcrumb as aC, type ParentCategory as aD, type SeoSchema as aE, type Keyword as aF, type Tag as aG, type Settings as aH, type RichContent as aI, type Node as aJ, type NodeDataOneOf as aK, type NodeStyle as aL, type ButtonData as aM, type Border as aN, type Colors as aO, type PluginContainerData as aP, type PluginContainerDataWidth as aQ, type PluginContainerDataWidthDataOneOf as aR, type Spoiler as aS, type Height as aT, type Styles as aU, type Link as aV, type LinkDataOneOf as aW, type Rel as aX, type CodeBlockData as aY, type TextStyle as aZ, type DividerData as a_, MapType as aa, ViewRole as ab, VoteRole as ac, PollLayoutType as ad, PollLayoutDirection as ae, BackgroundType as af, DecorationType as ag, FontType as ah, AppType as ai, InitialExpandedItems as aj, Direction as ak, VerticalAlignment as al, NullValue as am, SingleEntityOpsRequestedFields as an, SortOrder as ao, RequestedFields as ap, SortType as aq, SortDirection as ar, MissingValues as as, ScalarType as at, NestedAggregationType as au, Interval as av, AggregationType as aw, Mode as ax, Position as ay, MoveItemInCategoryRequestPosition as az, type UpdateCategoryOptions as b, type ListValue as b$, type FileSource as b0, type FileSourceDataOneOf as b1, type PDFSettings as b2, type GalleryData as b3, type Media as b4, type Image as b5, type Video as b6, type Item as b7, type ItemDataOneOf as b8, type GalleryOptions as b9, type OptionDesign as bA, type Poll as bB, type PollDataLayout as bC, type Design as bD, type TextData as bE, type Decoration as bF, type DecorationDataOneOf as bG, type AnchorData as bH, type ColorData as bI, type LinkData as bJ, type MentionData as bK, type FontSizeData as bL, type SpoilerData as bM, type AppEmbedData as bN, type AppEmbedDataAppDataOneOf as bO, type BookingData as bP, type EventData as bQ, type VideoData as bR, type PlaybackOptions as bS, type EmbedData as bT, type Oembed as bU, type CollapsibleListData as bV, type TableData as bW, type Dimensions as bX, type TableCellData as bY, type CellStyle as bZ, type BorderColors as b_, type Layout as ba, type ItemStyle as bb, type Thumbnails as bc, type GIFData as bd, type GIF as be, type HeadingData as bf, type HTMLData as bg, type HTMLDataDataOneOf as bh, type ImageData as bi, type StylesBorder as bj, type ImageDataStyles as bk, type LinkPreviewData as bl, type LinkPreviewDataStyles as bm, type MapData as bn, type MapSettings as bo, type ParagraphData as bp, type PollData as bq, type Permissions as br, type Option as bs, type PollSettings as bt, type PollLayout as bu, type OptionLayout as bv, type Gradient as bw, type Background as bx, type BackgroundBackgroundOneOf as by, type PollDesign as bz, type CategoriesQueryBuilder as c, type ValueResults as c$, type AudioData as c0, type OrderedListData as c1, type BulletedListData as c2, type BlockquoteData as c3, type CaptionData as c4, type LayoutCellData as c5, type Metadata as c6, type DocumentStyle as c7, type TextNodeStyle as c8, type ExtendedFields as c9, type QueryCategoriesResponse as cA, type CursorPagingMetadata as cB, type Cursors as cC, type ListCompactCategoriesByIdsRequest as cD, type ListCompactCategoriesByIdsResponse as cE, type CompactCategory as cF, type SearchCategoriesRequest as cG, type CursorSearch as cH, type CursorSearchPagingMethodOneOf as cI, type Aggregation as cJ, type AggregationKindOneOf as cK, type RangeBucket as cL, type IncludeMissingValuesOptions as cM, type ValueAggregation as cN, type ValueAggregationOptionsOneOf as cO, type RangeAggregation as cP, type ScalarAggregation as cQ, type DateHistogramAggregation as cR, type NestedAggregationItem as cS, type NestedAggregationItemKindOneOf as cT, type NestedAggregation as cU, type SearchDetails as cV, type AggregationData as cW, type ValueAggregationResult as cX, type RangeAggregationResult as cY, type NestedAggregationResults as cZ, type NestedAggregationResultsResultOneOf as c_, type InvalidateCache as ca, type InvalidateCacheGetByOneOf as cb, type App as cc, type Page as cd, type URI as ce, type File as cf, type CustomTag as cg, type CategoryMoved as ch, type ItemAddedToCategory as ci, type ItemsAddedToCategory as cj, type ItemRemovedFromCategory as ck, type ItemsRemovedFromCategory as cl, type ItemsArrangedInCategory as cm, type CreateCategoryRequest as cn, type CreateCategoryResponse as co, type GetCategoryRequest as cp, type GetCategoryResponse as cq, type UpdateCategoryRequest as cr, type UpdateCategoryResponse as cs, type DeleteCategoryRequest as ct, type DeleteCategoryResponse as cu, type QueryCategoriesRequest as cv, type CursorQuery as cw, type CursorQueryPagingMethodOneOf as cx, type Sorting as cy, type CursorPaging as cz, type SearchCategoriesResponse as d, type EntityCreatedEvent as d$, type RangeResults as d0, type AggregationResultsScalarResult as d1, type NestedValueAggregationResult as d2, type ValueResult as d3, type RangeResult as d4, type ScalarResult as d5, type NestedResultValue as d6, type NestedResultValueResultOneOf as d7, type Results as d8, type DateHistogramResult as d9, type BulkDeleteCategoriesResponse as dA, type BulkDeleteCategoriesResponseBulkCategoriesResult as dB, type BulkDeleteCategoriesByFilterRequest as dC, type BulkDeleteCategoriesByFilterResponse as dD, type BulkAddItemsToCategoryRequest as dE, type BulkItemsToCategoryResult as dF, type ItemReferenceMetadata as dG, type BulkAddItemToCategoriesRequest as dH, type BulkItemToCategoriesResult as dI, type BulkRemoveItemsFromCategoryRequest as dJ, type BulkRemoveItemFromCategoriesRequest as dK, type ListItemsInCategoryRequest as dL, type ListItemsInCategoryRequestPagingMethodOneOf as dM, type PagingMetadataV2 as dN, type ListCategoriesForItemRequest as dO, type ListCategoriesForItemsRequest as dP, type MapItemToCategories as dQ, type ListTreesRequest as dR, type MoveItemInCategoryRequest as dS, type MoveItemInCategoryResponse as dT, type SetArrangedItemsRequest as dU, type GetArrangedItemsRequest as dV, type GetCategoriesTreeRequest as dW, type GetCategoriesTreeResponse as dX, type CategoryTreeNode as dY, type DomainEvent as dZ, type DomainEventBodyOneOf as d_, type GroupByValueResults as da, type DateHistogramResults as db, type NestedResults as dc, type AggregationResults as dd, type AggregationResultsResultOneOf as de, type DeprecatedSearchCategoriesWithOffsetRequest as df, type OffsetSearch as dg, type OffsetSearchPagingMethodOneOf as dh, type Paging as di, type DeprecatedSearchCategoriesWithOffsetResponse as dj, type PagingMetadata as dk, type CountCategoriesRequest as dl, type MoveCategoryRequest as dm, type BulkCreateCategoriesRequest as dn, type BulkCreateCategoriesResponse as dp, type BulkCategoriesResult as dq, type ItemMetadata as dr, type ApplicationError as ds, type BulkActionMetadata as dt, type BulkUpdateCategoriesRequest as du, type UpdateCategoryVisibilityRequest as dv, type BulkShowCategoriesRequest as dw, type BulkUpdateCategoryVisibilityByFilterRequest as dx, type BulkUpdateCategoryVisibilityByFilterResponse as dy, type BulkDeleteCategoriesRequest as dz, type CountCategoriesOptions as e, type RestoreInfo as e0, type EntityUpdatedEvent as e1, type EntityDeletedEvent as e2, type ActionEvent as e3, type Empty as e4, type MessageEnvelope as e5, type IdentificationData as e6, type IdentificationDataIdOneOf as e7, type BaseEventMetadata as e8, type EventMetadata as e9, type CategoriesQueryResult as ea, type ListItemsInCategoryOptionsPagingMethodOneOf as eb, type CountCategoriesResponse as f, type MoveCategoryResponse as g, type MaskedCategory as h, type BulkUpdateCategoriesResponse as i, type UpdateCategoryVisibilityOptions as j, type UpdateCategoryVisibilityResponse as k, type BulkShowCategoriesOptions as l, type BulkShowCategoriesResponse as m, type BulkAddItemsToCategoryOptions as n, type BulkAddItemsToCategoryResponse as o, type BulkAddItemToCategoriesOptions as p, type BulkAddItemToCategoriesResponse as q, type BulkRemoveItemsFromCategoryOptions as r, type BulkRemoveItemsFromCategoryResponse as s, type BulkRemoveItemFromCategoriesOptions as t, type BulkRemoveItemFromCategoriesResponse as u, type ListItemsInCategoryResponse as v, type ListCategoriesForItemOptions as w, type ListCategoriesForItemResponse as x, type ListCategoriesForItemsOptions as y, type ListCategoriesForItemsResponse as z };
4905
+ export { type CategoryCreatedEnvelope as $, type BulkRemoveItemsFromCategoryResponse as A, type BulkUpdateCategoriesOptions as B, type Category as C, type DeleteCategoryApplicationErrors as D, type BulkRemoveItemsFromCategoryApplicationErrors as E, type BulkRemoveItemFromCategoriesOptions as F, type GetCategoryOptions as G, type BulkRemoveItemFromCategoriesResponse as H, type ItemReference as I, type BulkRemoveItemFromCategoriesApplicationErrors as J, type ListItemsInCategoryResponse as K, type ListItemsInCategoryOptions as L, type MoveCategoryOptions as M, type ListCategoriesForItemOptions as N, type ListCategoriesForItemResponse as O, type ListCategoriesForItemsOptions as P, type QueryCategoriesOptions as Q, type ListCategoriesForItemsResponse as R, type SearchCategoriesOptions as S, type TreeReference as T, type UpdateCategory as U, type ListTreesResponse as V, type SetArrangedItemsOptions as W, type SetArrangedItemsResponse as X, type SetArrangedItemsApplicationErrors as Y, type GetArrangedItemsResponse as Z, type CategoryMovedEnvelope as _, type CreateCategoryOptions as a, type RichContent as a$, type CategoryDeletedEnvelope as a0, type CategoryItemAddedToCategoryEnvelope as a1, type CategoryItemRemovedFromCategoryEnvelope as a2, type CategoryItemsArrangedInCategoryEnvelope as a3, type CategoryUpdatedEnvelope as a4, NodeType as a5, WidthType as a6, PluginContainerDataAlignment as a7, ButtonDataType as a8, Target as a9, Layout as aA, AppType as aB, InitialExpandedItems as aC, Direction as aD, VerticalAlignment as aE, NullValue as aF, SingleEntityOpsRequestedFields as aG, SortOrder as aH, RequestedFields as aI, SortType as aJ, SortDirection as aK, MissingValues as aL, ScalarType as aM, NestedAggregationType as aN, Interval as aO, AggregationType as aP, Mode as aQ, Position as aR, MoveItemInCategoryRequestPosition as aS, WebhookIdentityType as aT, type BreadcrumbsInfo as aU, type Breadcrumb as aV, type ParentCategory as aW, type SeoSchema as aX, type Keyword as aY, type Tag as aZ, type Settings as a_, TextAlignment as aa, LineStyle as ab, Width as ac, DividerDataAlignment as ad, ViewMode as ae, LayoutType as af, Orientation as ag, Crop as ah, ThumbnailsAlignment as ai, GIFType as aj, Source as ak, StylesPosition as al, MapType as am, ViewRole as an, VoteRole as ao, PollLayoutType as ap, PollLayoutDirection as aq, BackgroundType as ar, DecorationType as as, FontType as at, ImageStylesPosition as au, AspectRatio as av, Resizing as aw, Placement as ax, Type as ay, Alignment as az, type CreateCategoryApplicationErrors as b, type ColorData as b$, type Node as b0, type NodeDataOneOf as b1, type NodeStyle as b2, type ButtonData as b3, type Border as b4, type Colors as b5, type PluginContainerData as b6, type PluginContainerDataWidth as b7, type PluginContainerDataWidthDataOneOf as b8, type Spoiler as b9, type HTMLDataDataOneOf as bA, type ImageData as bB, type StylesBorder as bC, type ImageDataStyles as bD, type LinkPreviewData as bE, type LinkPreviewDataStyles as bF, type MapData as bG, type MapSettings as bH, type ParagraphData as bI, type PollData as bJ, type Permissions as bK, type Option as bL, type PollSettings as bM, type PollLayout as bN, type OptionLayout as bO, type Gradient as bP, type Background as bQ, type BackgroundBackgroundOneOf as bR, type PollDesign as bS, type OptionDesign as bT, type Poll as bU, type PollDataLayout as bV, type Design as bW, type TextData as bX, type Decoration as bY, type DecorationDataOneOf as bZ, type AnchorData as b_, type Height as ba, type Styles as bb, type Link as bc, type LinkDataOneOf as bd, type Rel as be, type CodeBlockData as bf, type TextStyle as bg, type DividerData as bh, type FileData as bi, type FileSource as bj, type FileSourceDataOneOf as bk, type PDFSettings as bl, type GalleryData as bm, type Media as bn, type Image as bo, type Video as bp, type Item as bq, type ItemDataOneOf as br, type GalleryOptions as bs, type GalleryOptionsLayout as bt, type ItemStyle as bu, type Thumbnails as bv, type GIFData as bw, type GIF as bx, type HeadingData as by, type HTMLData as bz, type UpdateCategoryOptions as c, type ListCompactCategoriesByIdsRequest as c$, type LinkData as c0, type MentionData as c1, type FontSizeData as c2, type SpoilerData as c3, type AppEmbedData as c4, type AppEmbedDataAppDataOneOf as c5, type BookingData as c6, type EventData as c7, type ButtonStyles as c8, type ImageStyles as c9, type App as cA, type Page as cB, type URI as cC, type File as cD, type CustomTag as cE, type CategoryMoved as cF, type ItemAddedToCategory as cG, type ItemsAddedToCategory as cH, type ItemRemovedFromCategory as cI, type ItemsRemovedFromCategory as cJ, type ItemsArrangedInCategory as cK, type CreateCategoryRequest as cL, type CreateCategoryResponse as cM, type GetCategoryRequest as cN, type GetCategoryResponse as cO, type UpdateCategoryRequest as cP, type UpdateCategoryResponse as cQ, type DeleteCategoryRequest as cR, type DeleteCategoryResponse as cS, type QueryCategoriesRequest as cT, type CursorQuery as cU, type CursorQueryPagingMethodOneOf as cV, type Sorting as cW, type CursorPaging as cX, type QueryCategoriesResponse as cY, type CursorPagingMetadata as cZ, type Cursors as c_, type RibbonStyles as ca, type CardStyles as cb, type PricingData as cc, type VideoData as cd, type PlaybackOptions as ce, type EmbedData as cf, type Oembed as cg, type CollapsibleListData as ch, type TableData as ci, type Dimensions as cj, type TableCellData as ck, type CellStyle as cl, type BorderColors as cm, type ListValue as cn, type AudioData as co, type OrderedListData as cp, type BulletedListData as cq, type BlockquoteData as cr, type CaptionData as cs, type LayoutCellData as ct, type Metadata as cu, type DocumentStyle as cv, type TextNodeStyle as cw, type ExtendedFields as cx, type InvalidateCache as cy, type InvalidateCacheGetByOneOf as cz, type UpdateCategoryApplicationErrors as d, type BulkRemoveItemsFromCategoryRequest as d$, type ListCompactCategoriesByIdsResponse as d0, type CompactCategory as d1, type SearchCategoriesRequest as d2, type CursorSearch as d3, type CursorSearchPagingMethodOneOf as d4, type Aggregation as d5, type AggregationKindOneOf as d6, type RangeBucket as d7, type IncludeMissingValuesOptions as d8, type ValueAggregation as d9, type DateHistogramResults as dA, type NestedResults as dB, type AggregationResults as dC, type AggregationResultsResultOneOf as dD, type DeprecatedSearchCategoriesWithOffsetRequest as dE, type OffsetSearch as dF, type OffsetSearchPagingMethodOneOf as dG, type Paging as dH, type DeprecatedSearchCategoriesWithOffsetResponse as dI, type PagingMetadata as dJ, type CountCategoriesRequest as dK, type MoveCategoryRequest as dL, type BulkUpdateCategoriesRequest as dM, type BulkCategoriesResult as dN, type ItemMetadata as dO, type ApplicationError as dP, type BulkActionMetadata as dQ, type UpdateCategoryVisibilityRequest as dR, type BulkShowCategoriesRequest as dS, type BulkDeleteCategoriesRequest as dT, type BulkDeleteCategoriesResponse as dU, type BulkDeleteCategoriesResponseBulkCategoriesResult as dV, type BulkAddItemsToCategoryRequest as dW, type BulkItemsToCategoryResult as dX, type ItemReferenceMetadata as dY, type BulkAddItemToCategoriesRequest as dZ, type BulkItemToCategoriesResult as d_, type ValueAggregationOptionsOneOf as da, type RangeAggregation as db, type ScalarAggregation as dc, type DateHistogramAggregation as dd, type NestedAggregationItem as de, type NestedAggregationItemKindOneOf as df, type NestedAggregation as dg, type SearchDetails as dh, type AggregationData as di, type ValueAggregationResult as dj, type RangeAggregationResult as dk, type NestedAggregationResults as dl, type NestedAggregationResultsResultOneOf as dm, type ValueResults as dn, type RangeResults as dp, type AggregationResultsScalarResult as dq, type NestedValueAggregationResult as dr, type ValueResult as ds, type RangeResult as dt, type ScalarResult as du, type NestedResultValue as dv, type NestedResultValueResultOneOf as dw, type Results as dx, type DateHistogramResult as dy, type GroupByValueResults as dz, type CategoriesQueryBuilder as e, type AppTypeWithLiterals as e$, type BulkRemoveItemFromCategoriesRequest as e0, type ListItemsInCategoryRequest as e1, type ListItemsInCategoryRequestPagingMethodOneOf as e2, type PagingMetadataV2 as e3, type ListCategoriesForItemRequest as e4, type ListCategoriesForItemsRequest as e5, type MapItemToCategories as e6, type ListTreesRequest as e7, type MoveItemInCategoryRequest as e8, type MoveItemInCategoryResponse as e9, type TextAlignmentWithLiterals as eA, type LineStyleWithLiterals as eB, type WidthWithLiterals as eC, type DividerDataAlignmentWithLiterals as eD, type ViewModeWithLiterals as eE, type LayoutTypeWithLiterals as eF, type OrientationWithLiterals as eG, type CropWithLiterals as eH, type ThumbnailsAlignmentWithLiterals as eI, type GIFTypeWithLiterals as eJ, type SourceWithLiterals as eK, type StylesPositionWithLiterals as eL, type MapTypeWithLiterals as eM, type ViewRoleWithLiterals as eN, type VoteRoleWithLiterals as eO, type PollLayoutTypeWithLiterals as eP, type PollLayoutDirectionWithLiterals as eQ, type BackgroundTypeWithLiterals as eR, type DecorationTypeWithLiterals as eS, type FontTypeWithLiterals as eT, type ImageStylesPositionWithLiterals as eU, type AspectRatioWithLiterals as eV, type ResizingWithLiterals as eW, type PlacementWithLiterals as eX, type TypeWithLiterals as eY, type AlignmentWithLiterals as eZ, type LayoutWithLiterals as e_, type SetArrangedItemsRequest as ea, type GetArrangedItemsRequest as eb, type GetCategoriesTreeRequest as ec, type GetCategoriesTreeResponse as ed, type CategoryTreeNode as ee, type DomainEvent as ef, type DomainEventBodyOneOf as eg, type EntityCreatedEvent as eh, type RestoreInfo as ei, type EntityUpdatedEvent as ej, type EntityDeletedEvent as ek, type ActionEvent as el, type Empty as em, type MessageEnvelope as en, type IdentificationData as eo, type IdentificationDataIdOneOf as ep, type BaseEventMetadata as eq, type EventMetadata as er, type CategoriesQueryResult as es, type CategorySearchSpec as et, type ListItemsInCategoryOptionsPagingMethodOneOf as eu, type NodeTypeWithLiterals as ev, type WidthTypeWithLiterals as ew, type PluginContainerDataAlignmentWithLiterals as ex, type ButtonDataTypeWithLiterals as ey, type TargetWithLiterals as ez, type CategorySearch as f, type InitialExpandedItemsWithLiterals as f0, type DirectionWithLiterals as f1, type VerticalAlignmentWithLiterals as f2, type NullValueWithLiterals as f3, type SingleEntityOpsRequestedFieldsWithLiterals as f4, type SortOrderWithLiterals as f5, type RequestedFieldsWithLiterals as f6, type SortTypeWithLiterals as f7, type SortDirectionWithLiterals as f8, type MissingValuesWithLiterals as f9, bulkAddItemsToCategory as fA, bulkAddItemToCategories as fB, bulkRemoveItemsFromCategory as fC, bulkRemoveItemFromCategories as fD, listItemsInCategory as fE, listCategoriesForItem as fF, listCategoriesForItems as fG, listTrees as fH, setArrangedItems as fI, getArrangedItems as fJ, type ScalarTypeWithLiterals as fa, type NestedAggregationTypeWithLiterals as fb, type IntervalWithLiterals as fc, type AggregationTypeWithLiterals as fd, type ModeWithLiterals as fe, type PositionWithLiterals as ff, type MoveItemInCategoryRequestPositionWithLiterals as fg, type WebhookIdentityTypeWithLiterals as fh, onCategoryMoved as fi, onCategoryCreated as fj, onCategoryDeleted as fk, onCategoryItemAddedToCategory as fl, onCategoryItemRemovedFromCategory as fm, onCategoryItemsArrangedInCategory as fn, onCategoryUpdated as fo, createCategory as fp, getCategory as fq, updateCategory as fr, deleteCategory as fs, queryCategories as ft, type CommonSearchWithEntityContext as fu, countCategories as fv, moveCategory as fw, bulkUpdateCategories as fx, updateCategoryVisibility as fy, bulkShowCategories as fz, type SearchCategoriesResponse as g, type CountCategoriesOptions as h, type CountCategoriesResponse as i, type MoveCategoryResponse as j, type MoveCategoryApplicationErrors as k, type MaskedCategory as l, type BulkUpdateCategoriesResponse as m, type BulkUpdateCategoriesApplicationErrors as n, type UpdateCategoryVisibilityOptions as o, type UpdateCategoryVisibilityResponse as p, type UpdateCategoryVisibilityApplicationErrors as q, type BulkShowCategoriesOptions as r, type BulkShowCategoriesResponse as s, type BulkAddItemsToCategoryOptions as t, type BulkAddItemsToCategoryResponse as u, type BulkAddItemsToCategoryApplicationErrors as v, type BulkAddItemToCategoriesOptions as w, type BulkAddItemToCategoriesResponse as x, type BulkAddItemToCategoriesApplicationErrors as y, type BulkRemoveItemsFromCategoryOptions as z };