@wix/categories 1.0.12 → 1.0.14

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 (31) hide show
  1. package/build/cjs/src/categories-v1-category.http.d.ts +3 -1
  2. package/build/cjs/src/categories-v1-category.http.js +90 -1
  3. package/build/cjs/src/categories-v1-category.http.js.map +1 -1
  4. package/build/cjs/src/categories-v1-category.meta.d.ts +1 -0
  5. package/build/cjs/src/categories-v1-category.meta.js +20 -1
  6. package/build/cjs/src/categories-v1-category.meta.js.map +1 -1
  7. package/build/cjs/src/categories-v1-category.public.d.ts +4 -3
  8. package/build/cjs/src/categories-v1-category.public.js +14 -1
  9. package/build/cjs/src/categories-v1-category.public.js.map +1 -1
  10. package/build/cjs/src/categories-v1-category.types.d.ts +760 -0
  11. package/build/cjs/src/categories-v1-category.types.js +39 -1
  12. package/build/cjs/src/categories-v1-category.types.js.map +1 -1
  13. package/build/cjs/src/categories-v1-category.universal.d.ts +782 -10
  14. package/build/cjs/src/categories-v1-category.universal.js +100 -1
  15. package/build/cjs/src/categories-v1-category.universal.js.map +1 -1
  16. package/build/es/src/categories-v1-category.http.d.ts +3 -1
  17. package/build/es/src/categories-v1-category.http.js +88 -0
  18. package/build/es/src/categories-v1-category.http.js.map +1 -1
  19. package/build/es/src/categories-v1-category.meta.d.ts +1 -0
  20. package/build/es/src/categories-v1-category.meta.js +18 -0
  21. package/build/es/src/categories-v1-category.meta.js.map +1 -1
  22. package/build/es/src/categories-v1-category.public.d.ts +4 -3
  23. package/build/es/src/categories-v1-category.public.js +7 -2
  24. package/build/es/src/categories-v1-category.public.js.map +1 -1
  25. package/build/es/src/categories-v1-category.types.d.ts +760 -0
  26. package/build/es/src/categories-v1-category.types.js +38 -0
  27. package/build/es/src/categories-v1-category.types.js.map +1 -1
  28. package/build/es/src/categories-v1-category.universal.d.ts +782 -10
  29. package/build/es/src/categories-v1-category.universal.js +97 -0
  30. package/build/es/src/categories-v1-category.universal.js.map +1 -1
  31. package/package.json +2 -2
@@ -1538,6 +1538,216 @@ export interface Cursors {
1538
1538
  /** Cursor pointing to previous page in the list of results. */
1539
1539
  prev?: string | null;
1540
1540
  }
1541
+ export interface SearchCategoriesRequest {
1542
+ /** WQL query expression. */
1543
+ search?: CursorSearch;
1544
+ /**
1545
+ * A reference to the tree that contains this category.
1546
+ * Used only in the first request. Following requests use the cursor token.
1547
+ */
1548
+ treeReference: TreeReference;
1549
+ /**
1550
+ * Whether hidden categories should be included in the response. Default is `false`.
1551
+ * Used only in the first request. Following requests use the cursor token.
1552
+ */
1553
+ includeHidden?: boolean;
1554
+ /** Fields to return in the response. When not provided, these fields are not returned. */
1555
+ fields?: RequestedFields[];
1556
+ }
1557
+ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
1558
+ /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
1559
+ cursorPaging?: CursorPaging;
1560
+ /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
1561
+ filter?: Record<string, any> | null;
1562
+ /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
1563
+ sort?: Sorting[];
1564
+ /** 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. */
1565
+ aggregations?: Aggregation[];
1566
+ /** free text to match in searchable fields */
1567
+ search?: SearchDetails;
1568
+ }
1569
+ /** @oneof */
1570
+ export interface CursorSearchPagingMethodOneOf {
1571
+ /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
1572
+ cursorPaging?: CursorPaging;
1573
+ }
1574
+ export interface Aggregation extends AggregationKindOneOf {
1575
+ value?: ValueAggregation;
1576
+ range?: RangeAggregation;
1577
+ scalar?: ScalarAggregation;
1578
+ name?: string | null;
1579
+ type?: AggregationType;
1580
+ fieldPath?: string;
1581
+ groupBy?: GroupByAggregation;
1582
+ }
1583
+ /** @oneof */
1584
+ export interface AggregationKindOneOf {
1585
+ value?: ValueAggregation;
1586
+ range?: RangeAggregation;
1587
+ scalar?: ScalarAggregation;
1588
+ }
1589
+ export interface RangeBucket {
1590
+ /** Inclusive lower bound of the range. Required if to is not given. */
1591
+ from?: number | null;
1592
+ /** Exclusive upper bound of the range. Required if from is not given. */
1593
+ to?: number | null;
1594
+ }
1595
+ export declare enum SortType {
1596
+ COUNT = "COUNT",
1597
+ VALUE = "VALUE"
1598
+ }
1599
+ export declare enum SortDirection {
1600
+ DESC = "DESC",
1601
+ ASC = "ASC"
1602
+ }
1603
+ export declare enum MissingValues {
1604
+ EXCLUDE = "EXCLUDE",
1605
+ INCLUDE = "INCLUDE"
1606
+ }
1607
+ export interface IncludeMissingValuesOptions {
1608
+ /** can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
1609
+ addToBucket?: string;
1610
+ }
1611
+ export declare enum ScalarType {
1612
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1613
+ COUNT_DISTINCT = "COUNT_DISTINCT",
1614
+ MIN = "MIN",
1615
+ MAX = "MAX",
1616
+ SUM = "SUM",
1617
+ AVG = "AVG"
1618
+ }
1619
+ export interface ValueAggregation extends ValueAggregationOptionsOneOf {
1620
+ /** options for including missing values */
1621
+ includeOptions?: IncludeMissingValuesOptions;
1622
+ sortType?: SortType;
1623
+ sortDirection?: SortDirection;
1624
+ /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
1625
+ limit?: number | null;
1626
+ /** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
1627
+ missingValues?: MissingValues;
1628
+ }
1629
+ /** @oneof */
1630
+ export interface ValueAggregationOptionsOneOf {
1631
+ /** options for including missing values */
1632
+ includeOptions?: IncludeMissingValuesOptions;
1633
+ }
1634
+ export declare enum AggregationType {
1635
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1636
+ VALUE = "VALUE",
1637
+ RANGE = "RANGE",
1638
+ SCALAR = "SCALAR"
1639
+ }
1640
+ export interface RangeAggregation {
1641
+ buckets?: RangeBucket[];
1642
+ }
1643
+ export interface ScalarAggregation {
1644
+ type?: ScalarType;
1645
+ }
1646
+ export interface GroupByAggregation extends GroupByAggregationKindOneOf {
1647
+ value?: ValueAggregation;
1648
+ name?: string | null;
1649
+ fieldPath?: string;
1650
+ }
1651
+ /** @oneof */
1652
+ export interface GroupByAggregationKindOneOf {
1653
+ value?: ValueAggregation;
1654
+ }
1655
+ export interface SearchDetails {
1656
+ /** boolean search mode */
1657
+ mode?: Mode;
1658
+ /** search term or expression */
1659
+ expression?: string | null;
1660
+ /** fields to search in. if empty - server will search in own default fields */
1661
+ fields?: string[];
1662
+ /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
1663
+ fuzzy?: boolean;
1664
+ }
1665
+ export declare enum Mode {
1666
+ /** any */
1667
+ OR = "OR",
1668
+ /** all */
1669
+ AND = "AND"
1670
+ }
1671
+ export interface SearchCategoriesResponse {
1672
+ /** Categories which satisfy the provided query. */
1673
+ categories?: Category[];
1674
+ /** Paging metadata. Contains cursor which can be used in next query. */
1675
+ pagingMetadata?: CursorPagingMetadata;
1676
+ /** Aggregation data. */
1677
+ aggregationData?: AggregationData;
1678
+ }
1679
+ export interface CursorPagingMetadata {
1680
+ /** Number of items returned in the response. */
1681
+ count?: number | null;
1682
+ /** Offset that was requested. */
1683
+ cursors?: Cursors;
1684
+ /**
1685
+ * Indicates if there are more results after the current page.
1686
+ * If `true`, another page of results can be retrieved.
1687
+ * If `false`, this is the last page.
1688
+ */
1689
+ hasNext?: boolean | null;
1690
+ }
1691
+ export interface AggregationData {
1692
+ /** key = aggregation name (as derived from search request) */
1693
+ results?: AggregationResults[];
1694
+ }
1695
+ export interface ValueAggregationResult {
1696
+ value?: string;
1697
+ count?: number;
1698
+ }
1699
+ export interface RangeAggregationResult {
1700
+ from?: number | null;
1701
+ to?: number | null;
1702
+ count?: number;
1703
+ }
1704
+ export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
1705
+ values?: ValueResults;
1706
+ ranges?: RangeResults;
1707
+ scalar?: ScalarResult;
1708
+ name?: string;
1709
+ type?: AggregationType;
1710
+ fieldPath?: string;
1711
+ }
1712
+ /** @oneof */
1713
+ export interface NestedAggregationResultsResultOneOf {
1714
+ values?: ValueResults;
1715
+ ranges?: RangeResults;
1716
+ scalar?: ScalarResult;
1717
+ }
1718
+ export interface ValueResults {
1719
+ results?: ValueAggregationResult[];
1720
+ }
1721
+ export interface RangeResults {
1722
+ results?: RangeAggregationResult[];
1723
+ }
1724
+ export interface ScalarResult {
1725
+ type?: ScalarType;
1726
+ value?: number;
1727
+ }
1728
+ export interface NestedValueAggregationResult {
1729
+ value?: string;
1730
+ nestedResults?: NestedAggregationResults;
1731
+ }
1732
+ export interface GroupByValueResults {
1733
+ results?: NestedValueAggregationResult[];
1734
+ }
1735
+ export interface AggregationResults extends AggregationResultsResultOneOf {
1736
+ values?: ValueResults;
1737
+ ranges?: RangeResults;
1738
+ scalar?: ScalarResult;
1739
+ groupedByValue?: GroupByValueResults;
1740
+ name?: string;
1741
+ type?: AggregationType;
1742
+ fieldPath?: string;
1743
+ }
1744
+ /** @oneof */
1745
+ export interface AggregationResultsResultOneOf {
1746
+ values?: ValueResults;
1747
+ ranges?: RangeResults;
1748
+ scalar?: ScalarResult;
1749
+ groupedByValue?: GroupByValueResults;
1750
+ }
1541
1751
  export interface MoveCategoryRequest {
1542
1752
  /** ID of category to place. */
1543
1753
  categoryId: string;
@@ -2006,7 +2216,486 @@ export interface ActionEvent {
2006
2216
  }
2007
2217
  export interface Empty {
2008
2218
  }
2009
- export interface CreateCategoryResponseNonNullableFields {
2219
+ export interface CreateCategoryResponseNonNullableFields {
2220
+ category?: {
2221
+ image: string;
2222
+ numberOfItems: number;
2223
+ breadcrumbs?: {
2224
+ values: {
2225
+ categoryId: string;
2226
+ categoryName: string;
2227
+ categorySlug: string;
2228
+ }[];
2229
+ };
2230
+ richContentDescription?: {
2231
+ nodes: {
2232
+ buttonData?: {
2233
+ containerData?: {
2234
+ width?: {
2235
+ size: WidthType;
2236
+ };
2237
+ alignment: PluginContainerDataAlignment;
2238
+ };
2239
+ type: Type;
2240
+ link?: {
2241
+ url: string;
2242
+ anchor: string;
2243
+ target: Target;
2244
+ };
2245
+ };
2246
+ codeBlockData?: {
2247
+ textStyle?: {
2248
+ textAlignment: TextAlignment;
2249
+ };
2250
+ };
2251
+ dividerData?: {
2252
+ containerData?: {
2253
+ width?: {
2254
+ size: WidthType;
2255
+ };
2256
+ alignment: PluginContainerDataAlignment;
2257
+ };
2258
+ lineStyle: LineStyle;
2259
+ width: Width;
2260
+ alignment: Alignment;
2261
+ };
2262
+ fileData?: {
2263
+ containerData?: {
2264
+ width?: {
2265
+ size: WidthType;
2266
+ };
2267
+ alignment: PluginContainerDataAlignment;
2268
+ };
2269
+ pdfSettings?: {
2270
+ viewMode: ViewMode;
2271
+ };
2272
+ };
2273
+ galleryData?: {
2274
+ containerData?: {
2275
+ width?: {
2276
+ size: WidthType;
2277
+ };
2278
+ alignment: PluginContainerDataAlignment;
2279
+ };
2280
+ items: {
2281
+ image?: {
2282
+ link?: {
2283
+ url: string;
2284
+ anchor: string;
2285
+ target: Target;
2286
+ };
2287
+ };
2288
+ }[];
2289
+ options?: {
2290
+ layout?: {
2291
+ type: LayoutType;
2292
+ orientation: Orientation;
2293
+ };
2294
+ item?: {
2295
+ crop: Crop;
2296
+ };
2297
+ thumbnails?: {
2298
+ placement: ThumbnailsAlignment;
2299
+ };
2300
+ };
2301
+ };
2302
+ gifData?: {
2303
+ containerData?: {
2304
+ width?: {
2305
+ size: WidthType;
2306
+ };
2307
+ alignment: PluginContainerDataAlignment;
2308
+ };
2309
+ height: number;
2310
+ width: number;
2311
+ };
2312
+ headingData?: {
2313
+ level: number;
2314
+ textStyle?: {
2315
+ textAlignment: TextAlignment;
2316
+ };
2317
+ };
2318
+ htmlData?: {
2319
+ url: string;
2320
+ html: string;
2321
+ containerData?: {
2322
+ width?: {
2323
+ size: WidthType;
2324
+ };
2325
+ alignment: PluginContainerDataAlignment;
2326
+ };
2327
+ source: Source;
2328
+ };
2329
+ imageData?: {
2330
+ containerData?: {
2331
+ width?: {
2332
+ size: WidthType;
2333
+ };
2334
+ alignment: PluginContainerDataAlignment;
2335
+ };
2336
+ link?: {
2337
+ url: string;
2338
+ anchor: string;
2339
+ target: Target;
2340
+ };
2341
+ };
2342
+ linkPreviewData?: {
2343
+ containerData?: {
2344
+ width?: {
2345
+ size: WidthType;
2346
+ };
2347
+ alignment: PluginContainerDataAlignment;
2348
+ };
2349
+ link?: {
2350
+ url: string;
2351
+ anchor: string;
2352
+ target: Target;
2353
+ };
2354
+ };
2355
+ mapData?: {
2356
+ containerData?: {
2357
+ width?: {
2358
+ size: WidthType;
2359
+ };
2360
+ alignment: PluginContainerDataAlignment;
2361
+ };
2362
+ mapSettings?: {
2363
+ mapType: MapType;
2364
+ };
2365
+ };
2366
+ paragraphData?: {
2367
+ textStyle?: {
2368
+ textAlignment: TextAlignment;
2369
+ };
2370
+ };
2371
+ pollData?: {
2372
+ containerData?: {
2373
+ width?: {
2374
+ size: WidthType;
2375
+ };
2376
+ alignment: PluginContainerDataAlignment;
2377
+ };
2378
+ poll?: {
2379
+ options: Option[];
2380
+ settings?: {
2381
+ permissions?: {
2382
+ view: ViewRole;
2383
+ vote: VoteRole;
2384
+ };
2385
+ };
2386
+ };
2387
+ layout?: {
2388
+ poll?: {
2389
+ type: PollLayoutType;
2390
+ direction: PollLayoutDirection;
2391
+ };
2392
+ };
2393
+ design?: {
2394
+ poll?: {
2395
+ background?: {
2396
+ type: BackgroundType;
2397
+ };
2398
+ };
2399
+ };
2400
+ };
2401
+ textData?: {
2402
+ text: string;
2403
+ decorations: {
2404
+ anchorData?: {
2405
+ anchor: string;
2406
+ };
2407
+ linkData?: {
2408
+ link?: {
2409
+ url: string;
2410
+ anchor: string;
2411
+ target: Target;
2412
+ };
2413
+ };
2414
+ mentionData?: {
2415
+ name: string;
2416
+ slug: string;
2417
+ };
2418
+ fontSizeData?: {
2419
+ unit: FontType;
2420
+ };
2421
+ type: DecorationType;
2422
+ }[];
2423
+ };
2424
+ appEmbedData?: {
2425
+ type: AppType;
2426
+ };
2427
+ videoData?: {
2428
+ containerData?: {
2429
+ width?: {
2430
+ size: WidthType;
2431
+ };
2432
+ alignment: PluginContainerDataAlignment;
2433
+ };
2434
+ };
2435
+ embedData?: {
2436
+ containerData?: {
2437
+ width?: {
2438
+ size: WidthType;
2439
+ };
2440
+ alignment: PluginContainerDataAlignment;
2441
+ };
2442
+ };
2443
+ collapsibleListData?: {
2444
+ containerData?: {
2445
+ width?: {
2446
+ size: WidthType;
2447
+ };
2448
+ alignment: PluginContainerDataAlignment;
2449
+ };
2450
+ initialExpandedItems: InitialExpandedItems;
2451
+ direction: Direction;
2452
+ };
2453
+ tableData?: {
2454
+ containerData?: {
2455
+ width?: {
2456
+ size: WidthType;
2457
+ };
2458
+ alignment: PluginContainerDataAlignment;
2459
+ };
2460
+ dimensions?: {
2461
+ colsWidthRatio: number[];
2462
+ rowsHeight: number[];
2463
+ colsMinWidth: number[];
2464
+ };
2465
+ };
2466
+ tableCellData?: {
2467
+ cellStyle?: {
2468
+ verticalAlignment: VerticalAlignment;
2469
+ };
2470
+ };
2471
+ audioData?: {
2472
+ containerData?: {
2473
+ width?: {
2474
+ size: WidthType;
2475
+ };
2476
+ alignment: PluginContainerDataAlignment;
2477
+ };
2478
+ };
2479
+ orderedListData?: {
2480
+ indentation: number;
2481
+ };
2482
+ bulletedListData?: {
2483
+ indentation: number;
2484
+ };
2485
+ blockquoteData?: {
2486
+ indentation: number;
2487
+ };
2488
+ type: NodeType;
2489
+ _id: string;
2490
+ nodes: NonNullable<NonNullable<NonNullable<CreateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
2491
+ }[];
2492
+ metadata?: {
2493
+ version: number;
2494
+ };
2495
+ documentStyle?: {
2496
+ headerOne?: {
2497
+ decorations: {
2498
+ anchorData?: {
2499
+ anchor: string;
2500
+ };
2501
+ linkData?: {
2502
+ link?: {
2503
+ url: string;
2504
+ anchor: string;
2505
+ target: Target;
2506
+ };
2507
+ };
2508
+ mentionData?: {
2509
+ name: string;
2510
+ slug: string;
2511
+ };
2512
+ fontSizeData?: {
2513
+ unit: FontType;
2514
+ };
2515
+ type: DecorationType;
2516
+ }[];
2517
+ };
2518
+ headerTwo?: {
2519
+ decorations: {
2520
+ anchorData?: {
2521
+ anchor: string;
2522
+ };
2523
+ linkData?: {
2524
+ link?: {
2525
+ url: string;
2526
+ anchor: string;
2527
+ target: Target;
2528
+ };
2529
+ };
2530
+ mentionData?: {
2531
+ name: string;
2532
+ slug: string;
2533
+ };
2534
+ fontSizeData?: {
2535
+ unit: FontType;
2536
+ };
2537
+ type: DecorationType;
2538
+ }[];
2539
+ };
2540
+ headerThree?: {
2541
+ decorations: {
2542
+ anchorData?: {
2543
+ anchor: string;
2544
+ };
2545
+ linkData?: {
2546
+ link?: {
2547
+ url: string;
2548
+ anchor: string;
2549
+ target: Target;
2550
+ };
2551
+ };
2552
+ mentionData?: {
2553
+ name: string;
2554
+ slug: string;
2555
+ };
2556
+ fontSizeData?: {
2557
+ unit: FontType;
2558
+ };
2559
+ type: DecorationType;
2560
+ }[];
2561
+ };
2562
+ headerFour?: {
2563
+ decorations: {
2564
+ anchorData?: {
2565
+ anchor: string;
2566
+ };
2567
+ linkData?: {
2568
+ link?: {
2569
+ url: string;
2570
+ anchor: string;
2571
+ target: Target;
2572
+ };
2573
+ };
2574
+ mentionData?: {
2575
+ name: string;
2576
+ slug: string;
2577
+ };
2578
+ fontSizeData?: {
2579
+ unit: FontType;
2580
+ };
2581
+ type: DecorationType;
2582
+ }[];
2583
+ };
2584
+ headerFive?: {
2585
+ decorations: {
2586
+ anchorData?: {
2587
+ anchor: string;
2588
+ };
2589
+ linkData?: {
2590
+ link?: {
2591
+ url: string;
2592
+ anchor: string;
2593
+ target: Target;
2594
+ };
2595
+ };
2596
+ mentionData?: {
2597
+ name: string;
2598
+ slug: string;
2599
+ };
2600
+ fontSizeData?: {
2601
+ unit: FontType;
2602
+ };
2603
+ type: DecorationType;
2604
+ }[];
2605
+ };
2606
+ headerSix?: {
2607
+ decorations: {
2608
+ anchorData?: {
2609
+ anchor: string;
2610
+ };
2611
+ linkData?: {
2612
+ link?: {
2613
+ url: string;
2614
+ anchor: string;
2615
+ target: Target;
2616
+ };
2617
+ };
2618
+ mentionData?: {
2619
+ name: string;
2620
+ slug: string;
2621
+ };
2622
+ fontSizeData?: {
2623
+ unit: FontType;
2624
+ };
2625
+ type: DecorationType;
2626
+ }[];
2627
+ };
2628
+ paragraph?: {
2629
+ decorations: {
2630
+ anchorData?: {
2631
+ anchor: string;
2632
+ };
2633
+ linkData?: {
2634
+ link?: {
2635
+ url: string;
2636
+ anchor: string;
2637
+ target: Target;
2638
+ };
2639
+ };
2640
+ mentionData?: {
2641
+ name: string;
2642
+ slug: string;
2643
+ };
2644
+ fontSizeData?: {
2645
+ unit: FontType;
2646
+ };
2647
+ type: DecorationType;
2648
+ }[];
2649
+ };
2650
+ blockquote?: {
2651
+ decorations: {
2652
+ anchorData?: {
2653
+ anchor: string;
2654
+ };
2655
+ linkData?: {
2656
+ link?: {
2657
+ url: string;
2658
+ anchor: string;
2659
+ target: Target;
2660
+ };
2661
+ };
2662
+ mentionData?: {
2663
+ name: string;
2664
+ slug: string;
2665
+ };
2666
+ fontSizeData?: {
2667
+ unit: FontType;
2668
+ };
2669
+ type: DecorationType;
2670
+ }[];
2671
+ };
2672
+ codeBlock?: {
2673
+ decorations: {
2674
+ anchorData?: {
2675
+ anchor: string;
2676
+ };
2677
+ linkData?: {
2678
+ link?: {
2679
+ url: string;
2680
+ anchor: string;
2681
+ target: Target;
2682
+ };
2683
+ };
2684
+ mentionData?: {
2685
+ name: string;
2686
+ slug: string;
2687
+ };
2688
+ fontSizeData?: {
2689
+ unit: FontType;
2690
+ };
2691
+ type: DecorationType;
2692
+ }[];
2693
+ };
2694
+ };
2695
+ };
2696
+ };
2697
+ }
2698
+ export interface GetCategoryResponseNonNullableFields {
2010
2699
  category?: {
2011
2700
  image: string;
2012
2701
  numberOfItems: number;
@@ -2277,7 +2966,7 @@ export interface CreateCategoryResponseNonNullableFields {
2277
2966
  };
2278
2967
  type: NodeType;
2279
2968
  _id: string;
2280
- nodes: NonNullable<NonNullable<NonNullable<CreateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
2969
+ nodes: NonNullable<NonNullable<NonNullable<GetCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
2281
2970
  }[];
2282
2971
  metadata?: {
2283
2972
  version: number;
@@ -2485,7 +3174,7 @@ export interface CreateCategoryResponseNonNullableFields {
2485
3174
  };
2486
3175
  };
2487
3176
  }
2488
- export interface GetCategoryResponseNonNullableFields {
3177
+ export interface UpdateCategoryResponseNonNullableFields {
2489
3178
  category?: {
2490
3179
  image: string;
2491
3180
  numberOfItems: number;
@@ -2756,7 +3445,7 @@ export interface GetCategoryResponseNonNullableFields {
2756
3445
  };
2757
3446
  type: NodeType;
2758
3447
  _id: string;
2759
- nodes: NonNullable<NonNullable<NonNullable<GetCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
3448
+ nodes: NonNullable<NonNullable<NonNullable<UpdateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
2760
3449
  }[];
2761
3450
  metadata?: {
2762
3451
  version: number;
@@ -2964,8 +3653,8 @@ export interface GetCategoryResponseNonNullableFields {
2964
3653
  };
2965
3654
  };
2966
3655
  }
2967
- export interface UpdateCategoryResponseNonNullableFields {
2968
- category?: {
3656
+ export interface QueryCategoriesResponseNonNullableFields {
3657
+ categories: {
2969
3658
  image: string;
2970
3659
  numberOfItems: number;
2971
3660
  breadcrumbs?: {
@@ -3235,7 +3924,7 @@ export interface UpdateCategoryResponseNonNullableFields {
3235
3924
  };
3236
3925
  type: NodeType;
3237
3926
  _id: string;
3238
- nodes: NonNullable<NonNullable<NonNullable<UpdateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
3927
+ nodes: NonNullable<NonNullable<NonNullable<QueryCategoriesResponseNonNullableFields>['categories'][0]>['richContentDescription']>['nodes'][];
3239
3928
  }[];
3240
3929
  metadata?: {
3241
3930
  version: number;
@@ -3441,9 +4130,9 @@ export interface UpdateCategoryResponseNonNullableFields {
3441
4130
  };
3442
4131
  };
3443
4132
  };
3444
- };
4133
+ }[];
3445
4134
  }
3446
- export interface QueryCategoriesResponseNonNullableFields {
4135
+ export interface SearchCategoriesResponseNonNullableFields {
3447
4136
  categories: {
3448
4137
  image: string;
3449
4138
  numberOfItems: number;
@@ -3714,7 +4403,7 @@ export interface QueryCategoriesResponseNonNullableFields {
3714
4403
  };
3715
4404
  type: NodeType;
3716
4405
  _id: string;
3717
- nodes: NonNullable<NonNullable<NonNullable<QueryCategoriesResponseNonNullableFields>['categories'][0]>['richContentDescription']>['nodes'][];
4406
+ nodes: NonNullable<NonNullable<NonNullable<SearchCategoriesResponseNonNullableFields>['categories'][0]>['richContentDescription']>['nodes'][];
3718
4407
  }[];
3719
4408
  metadata?: {
3720
4409
  version: number;
@@ -3921,6 +4610,53 @@ export interface QueryCategoriesResponseNonNullableFields {
3921
4610
  };
3922
4611
  };
3923
4612
  }[];
4613
+ aggregationData?: {
4614
+ results: {
4615
+ values?: {
4616
+ results: {
4617
+ value: string;
4618
+ count: number;
4619
+ }[];
4620
+ };
4621
+ ranges?: {
4622
+ results: {
4623
+ count: number;
4624
+ }[];
4625
+ };
4626
+ scalar?: {
4627
+ type: ScalarType;
4628
+ value: number;
4629
+ };
4630
+ groupedByValue?: {
4631
+ results: {
4632
+ value: string;
4633
+ nestedResults?: {
4634
+ values?: {
4635
+ results: {
4636
+ value: string;
4637
+ count: number;
4638
+ }[];
4639
+ };
4640
+ ranges?: {
4641
+ results: {
4642
+ count: number;
4643
+ }[];
4644
+ };
4645
+ scalar?: {
4646
+ type: ScalarType;
4647
+ value: number;
4648
+ };
4649
+ name: string;
4650
+ type: AggregationType;
4651
+ fieldPath: string;
4652
+ };
4653
+ }[];
4654
+ };
4655
+ name: string;
4656
+ type: AggregationType;
4657
+ fieldPath: string;
4658
+ }[];
4659
+ };
3924
4660
  }
3925
4661
  export interface MoveCategoryResponseNonNullableFields {
3926
4662
  categoriesAfterMove: string[];
@@ -5186,11 +5922,21 @@ export interface CategoriesQueryBuilder {
5186
5922
  * @documentationMaturity preview
5187
5923
  */
5188
5924
  ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
5925
+ /** @param propertyName - Property whose value is compared with `value`.
5926
+ * @param value - Value to compare against.
5927
+ * @documentationMaturity preview
5928
+ */
5929
+ ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
5189
5930
  /** @param propertyName - Property whose value is compared with `value`.
5190
5931
  * @param value - Value to compare against.
5191
5932
  * @documentationMaturity preview
5192
5933
  */
5193
5934
  gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
5935
+ /** @param propertyName - Property whose value is compared with `value`.
5936
+ * @param value - Value to compare against.
5937
+ * @documentationMaturity preview
5938
+ */
5939
+ le: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
5194
5940
  /** @param propertyName - Property whose value is compared with `value`.
5195
5941
  * @param value - Value to compare against.
5196
5942
  * @documentationMaturity preview
@@ -5229,6 +5975,32 @@ export interface CategoriesQueryBuilder {
5229
5975
  /** @documentationMaturity preview */
5230
5976
  find: () => Promise<CategoriesQueryResult>;
5231
5977
  }
5978
+ /**
5979
+ * Search Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
5980
+ * @public
5981
+ * @documentationMaturity preview
5982
+ * @requiredField options.treeReference
5983
+ * @requiredField options.treeReference.appNamespace
5984
+ * @applicableIdentity MEMBER
5985
+ * @applicableIdentity VISITOR
5986
+ */
5987
+ export declare function searchCategories(options?: SearchCategoriesOptions): Promise<SearchCategoriesResponse & SearchCategoriesResponseNonNullableFields>;
5988
+ export interface SearchCategoriesOptions {
5989
+ /** WQL query expression. */
5990
+ search?: CursorSearch;
5991
+ /**
5992
+ * A reference to the tree that contains this category.
5993
+ * Used only in the first request. Following requests use the cursor token.
5994
+ */
5995
+ treeReference: TreeReference;
5996
+ /**
5997
+ * Whether hidden categories should be included in the response. Default is `false`.
5998
+ * Used only in the first request. Following requests use the cursor token.
5999
+ */
6000
+ includeHidden?: boolean;
6001
+ /** Fields to return in the response. When not provided, these fields are not returned. */
6002
+ fields?: RequestedFields[];
6003
+ }
5232
6004
  /**
5233
6005
  * Moves a category.
5234
6006
  * This operation updates `parentCategory` (`id` and `index`) for category with `categoryId`.