@wix/auto_sdk_categories_categories 1.0.63 → 1.0.65

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 (41) hide show
  1. package/build/cjs/{categories-v1-category-categories.universal-C77jUy-2.d.ts → categories-v1-category-categories.universal-CXnlcgkq.d.ts} +256 -196
  2. package/build/cjs/index.d.ts +48 -43
  3. package/build/cjs/index.js +63 -0
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +28 -14
  6. package/build/cjs/index.typings.js +54 -0
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +251 -143
  9. package/build/cjs/meta.js +38 -0
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{categories-v1-category-categories.universal-C77jUy-2.d.mts → categories-v1-category-categories.universal-CXnlcgkq.d.mts} +256 -196
  12. package/build/es/index.d.mts +48 -43
  13. package/build/es/index.mjs +62 -0
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +28 -14
  16. package/build/es/index.typings.mjs +53 -0
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +251 -143
  19. package/build/es/meta.mjs +37 -0
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{categories-v1-category-categories.universal-C77jUy-2.d.ts → categories-v1-category-categories.universal-EEVOXDre.d.ts} +275 -196
  22. package/build/internal/cjs/index.d.ts +62 -43
  23. package/build/internal/cjs/index.js +63 -0
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +28 -14
  26. package/build/internal/cjs/index.typings.js +54 -0
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +251 -143
  29. package/build/internal/cjs/meta.js +38 -0
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/es/{categories-v1-category-categories.universal-C77jUy-2.d.mts → categories-v1-category-categories.universal-EEVOXDre.d.mts} +275 -196
  32. package/build/internal/es/index.d.mts +62 -43
  33. package/build/internal/es/index.mjs +62 -0
  34. package/build/internal/es/index.mjs.map +1 -1
  35. package/build/internal/es/index.typings.d.mts +28 -14
  36. package/build/internal/es/index.typings.mjs +53 -0
  37. package/build/internal/es/index.typings.mjs.map +1 -1
  38. package/build/internal/es/meta.d.mts +251 -143
  39. package/build/internal/es/meta.mjs +37 -0
  40. package/build/internal/es/meta.mjs.map +1 -1
  41. package/package.json +3 -3
@@ -78,6 +78,8 @@ interface Category {
78
78
  * @format URL_SLUG
79
79
  */
80
80
  slug?: string | null;
81
+ /** Custom SEO data for the category. */
82
+ seoData?: SeoSchema;
81
83
  /**
82
84
  * Category description using rich content.
83
85
  * > **Note:** Returned only when you pass `"RICH_CONTENT_DESCRIPTION"` to the `fields` array in Categories API requests.
@@ -2378,7 +2380,13 @@ interface CompactCategory {
2378
2380
  name?: string | null;
2379
2381
  }
2380
2382
  interface SearchCategoriesRequest {
2381
- /** Search options. */
2383
+ /**
2384
+ * Search criteria including filter, sort, aggregations, and paging options.
2385
+ *
2386
+ * Refer to the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
2387
+ * or the [supported filters article](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting) (REST)
2388
+ * for a complete list of supported filters and sorting options.
2389
+ */
2382
2390
  search?: CursorSearch;
2383
2391
  /**
2384
2392
  * Category tree reference details.
@@ -2386,45 +2394,50 @@ interface SearchCategoriesRequest {
2386
2394
  */
2387
2395
  treeReference: TreeReference;
2388
2396
  /**
2389
- * Whether to return the categories with `visible: false`.
2397
+ * Whether to return the categories with `visible` set to `false`.
2390
2398
  *
2391
- * Default: `false` - only visible categories are returned in the response
2399
+ * Default: `false`. Only visible categories are returned in the response
2392
2400
  */
2393
2401
  returnNonVisibleCategories?: boolean;
2394
2402
  /**
2395
- * Fields to include in the response.
2403
+ * Array of projected fields. A list of specific field names to return.
2396
2404
  * @maxSize 100
2397
2405
  */
2398
2406
  fields?: RequestedFieldsWithLiterals[];
2399
2407
  }
2400
2408
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
2401
2409
  /**
2402
- * Cursor pointing to page of results.
2403
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
2410
+ * Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
2411
+ * `filter`, `sort`, or `search` can't be specified.
2404
2412
  */
2405
2413
  cursorPaging?: CursorPaging;
2406
- /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
2414
+ /**
2415
+ * Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
2416
+ *
2417
+ * Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
2418
+ * or the [supported filters article](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting) (REST).
2419
+ */
2407
2420
  filter?: Record<string, any> | null;
2408
2421
  /**
2409
- * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
2422
+ * Array of sort objects specifying result order. For example, to sort by creation date in ascending order: `"sort": [{"fieldName": "createdDate", "order": "ASC"}]`.
2423
+ *
2424
+ * Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
2425
+ * or the [supported filters article](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting) (REST).
2410
2426
  * @maxSize 10
2411
2427
  */
2412
2428
  sort?: Sorting[];
2413
2429
  /**
2414
- * 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.
2430
+ * Aggregations for grouping data into categories (facets) and providing summaries for each category.
2431
+ * For example, use aggregations to categorize search results by service type, payment options, or locations.
2415
2432
  * @maxSize 10
2416
2433
  */
2417
2434
  aggregations?: Aggregation[];
2418
- /** Free text to match in searchable fields */
2435
+ /** Free text to match in searchable fields. */
2419
2436
  search?: SearchDetails;
2420
2437
  /**
2421
- * UTC offset or IANA time zone. Valid values are
2422
- * ISO 8601 UTC offsets, such as +02:00 or -06:00,
2423
- * and IANA time zone IDs, such as Europe/Rome
2438
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) or [ISO 8601 UTC offset format](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC) for adjusting time fields in the specified filters and returned aggregation data. For example, `America/New_York`, `UTC`, or `+02:00`.
2424
2439
  *
2425
- * Affects all filters and aggregations returned values.
2426
- * You may override this behavior in a specific filter by providing
2427
- * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
2440
+ * Default: Time zone specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
2428
2441
  * @maxLength 50
2429
2442
  */
2430
2443
  timeZone?: string | null;
@@ -2432,52 +2445,52 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
2432
2445
  /** @oneof */
2433
2446
  interface CursorSearchPagingMethodOneOf {
2434
2447
  /**
2435
- * Cursor pointing to page of results.
2436
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
2448
+ * Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
2449
+ * `filter`, `sort`, or `search` can't be specified.
2437
2450
  */
2438
2451
  cursorPaging?: CursorPaging;
2439
2452
  }
2440
2453
  interface Aggregation extends AggregationKindOneOf {
2441
- /** Value aggregation */
2454
+ /** Value aggregation configuration. */
2442
2455
  value?: ValueAggregation;
2443
- /** Range aggregation */
2456
+ /** Range aggregation configuration. */
2444
2457
  range?: RangeAggregation;
2445
- /** Scalar aggregation */
2458
+ /** Scalar aggregation configuration. */
2446
2459
  scalar?: ScalarAggregation;
2447
- /** Date histogram aggregation */
2460
+ /** Date histogram aggregation configuration. */
2448
2461
  dateHistogram?: DateHistogramAggregation;
2449
- /** Nested aggregation */
2462
+ /** Nested aggregation configuration. */
2450
2463
  nested?: NestedAggregation;
2451
2464
  /**
2452
- * User-defined name of aggregation, should be unique, will appear in aggregation results
2465
+ * User-defined name of aggregation. Must be unique and will appear in aggregation results.
2453
2466
  * @maxLength 100
2454
2467
  */
2455
2468
  name?: string | null;
2456
- /** Type of aggregation, client must provide matching aggregation field below */
2469
+ /** Type of aggregation. Client must specify matching aggregation field below. */
2457
2470
  type?: AggregationTypeWithLiterals;
2458
2471
  /**
2459
- * Field to aggregate by, use dot notation to specify json path
2472
+ * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
2460
2473
  * @maxLength 200
2461
2474
  */
2462
2475
  fieldPath?: string;
2463
2476
  }
2464
2477
  /** @oneof */
2465
2478
  interface AggregationKindOneOf {
2466
- /** Value aggregation */
2479
+ /** Value aggregation configuration. */
2467
2480
  value?: ValueAggregation;
2468
- /** Range aggregation */
2481
+ /** Range aggregation configuration. */
2469
2482
  range?: RangeAggregation;
2470
- /** Scalar aggregation */
2483
+ /** Scalar aggregation configuration. */
2471
2484
  scalar?: ScalarAggregation;
2472
- /** Date histogram aggregation */
2485
+ /** Date histogram aggregation configuration. */
2473
2486
  dateHistogram?: DateHistogramAggregation;
2474
- /** Nested aggregation */
2487
+ /** Nested aggregation configuration. */
2475
2488
  nested?: NestedAggregation;
2476
2489
  }
2477
2490
  interface RangeBucket {
2478
- /** Inclusive lower bound of the range. Required if to is not given */
2491
+ /** Inclusive lower bound of the range. Required if `to` isn't specified. */
2479
2492
  from?: number | null;
2480
- /** Exclusive upper bound of the range. Required if from is not given */
2493
+ /** Exclusive upper bound of the range. Required if `from` isn't specified. */
2481
2494
  to?: number | null;
2482
2495
  }
2483
2496
  declare enum SortType {
@@ -2489,9 +2502,9 @@ declare enum SortType {
2489
2502
  /** @enumType */
2490
2503
  type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
2491
2504
  declare enum SortDirection {
2492
- /** Sort in descending order. */
2505
+ /** Descending order. */
2493
2506
  DESC = "DESC",
2494
- /** Sort in ascending order. */
2507
+ /** Ascending order. */
2495
2508
  ASC = "ASC"
2496
2509
  }
2497
2510
  /** @enumType */
@@ -2499,21 +2512,26 @@ type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
2499
2512
  declare enum MissingValues {
2500
2513
  /** Exclude missing values from the aggregation results. */
2501
2514
  EXCLUDE = "EXCLUDE",
2502
- /** Included missing values in the aggregation results. */
2515
+ /** Include missing values in the aggregation results. */
2503
2516
  INCLUDE = "INCLUDE"
2504
2517
  }
2505
2518
  /** @enumType */
2506
2519
  type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
2507
2520
  interface IncludeMissingValuesOptions {
2508
2521
  /**
2509
- * Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
2522
+ * Custom bucket name for missing values.
2523
+ *
2524
+ * Default values:
2525
+ * - string: `N/A`
2526
+ * - int: `0`
2527
+ * - bool: `false`
2510
2528
  * @maxLength 20
2511
2529
  */
2512
2530
  addToBucket?: string;
2513
2531
  }
2514
2532
  declare enum ScalarType {
2515
2533
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
2516
- /** Count of distinct values. */
2534
+ /** Total number of distinct values. */
2517
2535
  COUNT_DISTINCT = "COUNT_DISTINCT",
2518
2536
  /** Minimum value. */
2519
2537
  MIN = "MIN",
@@ -2523,132 +2541,139 @@ declare enum ScalarType {
2523
2541
  /** @enumType */
2524
2542
  type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
2525
2543
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
2526
- /** Options for including missing values */
2544
+ /** Options for including missing values in the aggregation results. */
2527
2545
  includeOptions?: IncludeMissingValuesOptions;
2528
- /** Type of sort to perform. */
2546
+ /** Whether to sort by number of matches or value of the field. */
2529
2547
  sortType?: SortTypeWithLiterals;
2530
- /** Direction to sort in. */
2548
+ /** Whether to sort in ascending or descending order. */
2531
2549
  sortDirection?: SortDirectionWithLiterals;
2532
- /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
2550
+ /**
2551
+ * Number of aggregations to return.
2552
+ *
2553
+ * Min: `1`
2554
+ * Max: `250`
2555
+ * Default: `10`
2556
+ */
2533
2557
  limit?: number | null;
2534
2558
  /**
2535
- * Whether missing values are included in the aggregation results.
2559
+ * Whether missing values should be included or excluded from the aggregation results.
2560
+ *
2536
2561
  * Default: `EXCLUDE`
2537
2562
  */
2538
2563
  missingValues?: MissingValuesWithLiterals;
2539
2564
  }
2540
2565
  /** @oneof */
2541
2566
  interface ValueAggregationOptionsOneOf {
2542
- /** Options for including missing values */
2567
+ /** Options for including missing values in the aggregation results. */
2543
2568
  includeOptions?: IncludeMissingValuesOptions;
2544
2569
  }
2545
2570
  declare enum NestedAggregationType {
2546
2571
  /** Unknown aggregation type. */
2547
2572
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2548
- /** An aggregation where result buckets are dynamically built - one per unique value. */
2573
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
2549
2574
  VALUE = "VALUE",
2550
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
2575
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
2551
2576
  RANGE = "RANGE",
2552
- /** A single-value metric aggregation - such as min, max, sum, and avg. */
2577
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into 1 key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
2553
2578
  SCALAR = "SCALAR",
2554
- /** An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week. */
2579
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
2555
2580
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
2556
2581
  }
2557
2582
  /** @enumType */
2558
2583
  type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
2559
2584
  interface RangeAggregation {
2560
2585
  /**
2561
- * List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
2586
+ * List of range buckets defining the ranges for aggregation. During aggregation, each entity is placed in the first bucket where its value falls within the specified range bounds.
2562
2587
  * @maxSize 50
2563
2588
  */
2564
2589
  buckets?: RangeBucket[];
2565
2590
  }
2566
2591
  interface ScalarAggregation {
2567
- /** Define the operator for the scalar aggregation */
2592
+ /** Operator for the scalar aggregation, for example `COUNT_DISTINCT`, `MIN`, `MAX`. */
2568
2593
  type?: ScalarTypeWithLiterals;
2569
2594
  }
2570
2595
  interface DateHistogramAggregation {
2571
- /** Interval for date histogram aggregation */
2596
+ /** Time interval for date histogram aggregation, for example `DAY`, `HOUR`, `MONTH`. */
2572
2597
  interval?: IntervalWithLiterals;
2573
2598
  }
2574
2599
  declare enum Interval {
2575
2600
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
2576
- /** Yearly interval */
2601
+ /** Yearly interval. */
2577
2602
  YEAR = "YEAR",
2578
- /** Monthly interval */
2603
+ /** Monthly interval. */
2579
2604
  MONTH = "MONTH",
2580
- /** Weekly interval */
2605
+ /** Weekly interval. */
2581
2606
  WEEK = "WEEK",
2582
- /** Daily interval */
2607
+ /** Daily interval. */
2583
2608
  DAY = "DAY",
2584
- /** Hourly interval */
2609
+ /** Hourly interval. */
2585
2610
  HOUR = "HOUR",
2586
- /** Minute interval */
2611
+ /** Minute interval. */
2587
2612
  MINUTE = "MINUTE",
2588
- /** Second interval */
2613
+ /** Second interval. */
2589
2614
  SECOND = "SECOND"
2590
2615
  }
2591
2616
  /** @enumType */
2592
2617
  type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
2593
2618
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
2594
- /** Value aggregation */
2619
+ /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
2595
2620
  value?: ValueAggregation;
2596
- /** Range aggregation */
2621
+ /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
2597
2622
  range?: RangeAggregation;
2598
- /** Scalar aggregation */
2623
+ /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
2599
2624
  scalar?: ScalarAggregation;
2600
- /** Date histogram aggregation */
2625
+ /** Date histogram aggregation configuration. Calculates counts within time intervals. */
2601
2626
  dateHistogram?: DateHistogramAggregation;
2602
2627
  /**
2603
- * User-defined name of aggregation, should be unique, will appear in aggregation results
2628
+ * User-defined name of aggregation. Must be unique and will appear in aggregation results.
2604
2629
  * @maxLength 100
2605
2630
  */
2606
2631
  name?: string | null;
2607
- /** Type of aggregation client must provide matching aggregation field below */
2632
+ /** Type of aggregation. Client must specify matching aggregation field below. */
2608
2633
  type?: NestedAggregationTypeWithLiterals;
2609
2634
  /**
2610
- * Field to aggregate by, use dont notation to specify json path
2635
+ * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
2611
2636
  * @maxLength 200
2612
2637
  */
2613
2638
  fieldPath?: string;
2614
2639
  }
2615
2640
  /** @oneof */
2616
2641
  interface NestedAggregationItemKindOneOf {
2617
- /** Value aggregation */
2642
+ /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
2618
2643
  value?: ValueAggregation;
2619
- /** Range aggregation */
2644
+ /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
2620
2645
  range?: RangeAggregation;
2621
- /** Scalar aggregation */
2646
+ /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
2622
2647
  scalar?: ScalarAggregation;
2623
- /** Date histogram aggregation */
2648
+ /** Date histogram aggregation configuration. Calculates counts within time intervals. */
2624
2649
  dateHistogram?: DateHistogramAggregation;
2625
2650
  }
2626
2651
  declare enum AggregationType {
2627
2652
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2628
- /** An aggregation where result buckets are dynamically built - one per unique value. */
2653
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
2629
2654
  VALUE = "VALUE",
2630
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
2655
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
2631
2656
  RANGE = "RANGE",
2632
- /** A single-value metric aggregation - such as min, max, sum, and avg. */
2657
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into 1 key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
2633
2658
  SCALAR = "SCALAR",
2634
- /** An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week. */
2659
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
2635
2660
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
2636
- /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
2661
+ /** Flattened list of aggregations, where each aggregation is nested within previous 1. */
2637
2662
  NESTED = "NESTED"
2638
2663
  }
2639
2664
  /** @enumType */
2640
2665
  type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
2641
- /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
2666
+ /** Nested aggregation for multi-level faceted search. Allows exploring large amounts of data through multiple levels of categorization, where each subsequent aggregation is nested within the previous aggregation to create hierarchical data summaries. */
2642
2667
  interface NestedAggregation {
2643
2668
  /**
2644
- * Flattened list of aggregations, where each next aggregation is nested within previous one
2669
+ * Flattened list of aggregations, where each next aggregation is nested within the previous 1.
2645
2670
  * @minSize 2
2646
2671
  * @maxSize 3
2647
2672
  */
2648
2673
  nestedAggregations?: NestedAggregationItem[];
2649
2674
  }
2650
2675
  interface SearchDetails {
2651
- /** Defines how separate search terms in `expression` are combined. */
2676
+ /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
2652
2677
  mode?: ModeWithLiterals;
2653
2678
  /**
2654
2679
  * Search term or expression.
@@ -2656,18 +2681,16 @@ interface SearchDetails {
2656
2681
  */
2657
2682
  expression?: string | null;
2658
2683
  /**
2659
- * Fields in which to search for the `expression`. Use dot notation to specify field path.
2660
- *
2661
- * When empty - all searchable fields are looked at.
2684
+ * Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `parentCategory.index`.
2662
2685
  * @maxLength 200
2663
2686
  * @maxSize 20
2664
2687
  */
2665
2688
  fields?: string[];
2666
- /** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
2689
+ /** Whether to enable the search method to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
2667
2690
  fuzzy?: boolean;
2668
2691
  }
2669
2692
  declare enum Mode {
2670
- /** Any of the search terms must be present. */
2693
+ /** At least 1 of the search terms must be present. */
2671
2694
  OR = "OR",
2672
2695
  /** All search terms must be present. */
2673
2696
  AND = "AND"
@@ -2676,18 +2699,30 @@ declare enum Mode {
2676
2699
  type ModeWithLiterals = Mode | 'OR' | 'AND';
2677
2700
  interface SearchCategoriesResponse {
2678
2701
  /**
2679
- * List of categories.
2702
+ * Retrieved categories that match the search criteria specified in the request.
2703
+ *
2704
+ * Each category includes all standard category information.
2680
2705
  * @maxSize 1000
2681
2706
  */
2682
2707
  categories?: Category[];
2683
- /** Paging metadata. */
2708
+ /**
2709
+ * Cursor-based paging metadata for navigating search results.
2710
+ *
2711
+ * Contains the current page's cursor information, whether there are more results available,
2712
+ * and count details. Use the `next` cursor to retrieve subsequent pages of results.
2713
+ */
2684
2714
  pagingMetadata?: CursorPagingMetadata;
2685
- /** Aggregation data. */
2715
+ /**
2716
+ * Aggregation results based on the aggregations specified in the search request.
2717
+ *
2718
+ * Provides categorized data summaries. Only available when aggregations
2719
+ * are requested in the search criteria.
2720
+ */
2686
2721
  aggregationData?: AggregationData;
2687
2722
  }
2688
2723
  interface AggregationData {
2689
2724
  /**
2690
- * key = aggregation name (as derived from search request)
2725
+ * Array of aggregation results, each containing the aggregation metadata and its calculated values for the specified search criteria.
2691
2726
  * @maxSize 10000
2692
2727
  */
2693
2728
  results?: AggregationResults[];
@@ -2702,190 +2737,190 @@ interface ValueAggregationResult {
2702
2737
  count?: number;
2703
2738
  }
2704
2739
  interface RangeAggregationResult {
2705
- /** Inclusive lower bound of the range */
2740
+ /** Inclusive lower bound of the range. */
2706
2741
  from?: number | null;
2707
- /** Exclusive upper bound of the range */
2742
+ /** Exclusive upper bound of the range. */
2708
2743
  to?: number | null;
2709
- /** Count of entities in this range */
2744
+ /** Count of entities in this range. */
2710
2745
  count?: number;
2711
2746
  }
2712
2747
  interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
2713
- /** Value aggregation results */
2748
+ /** Value aggregation results. */
2714
2749
  values?: ValueResults;
2715
- /** Range aggregation results */
2750
+ /** Range aggregation results. */
2716
2751
  ranges?: RangeResults;
2717
- /** Scalar aggregation results */
2752
+ /** Scalar aggregation results. */
2718
2753
  scalar?: AggregationResultsScalarResult;
2719
2754
  /**
2720
- * User-defined name of aggregation, matches the one provided in request
2755
+ * User-defined name of aggregation, matches the one specified in request.
2721
2756
  * @maxLength 100
2722
2757
  */
2723
2758
  name?: string;
2724
- /** Type of aggregation that matches result */
2759
+ /** Type of aggregation that matches result. */
2725
2760
  type?: AggregationTypeWithLiterals;
2726
2761
  /**
2727
- * Field to aggregate by, matches the one provided in request
2762
+ * Path to the field to aggregate by in dot notation. For example `appNamespace`.
2728
2763
  * @maxLength 200
2729
2764
  */
2730
2765
  fieldPath?: string;
2731
2766
  }
2732
2767
  /** @oneof */
2733
2768
  interface NestedAggregationResultsResultOneOf {
2734
- /** Value aggregation results */
2769
+ /** Value aggregation results. */
2735
2770
  values?: ValueResults;
2736
- /** Range aggregation results */
2771
+ /** Range aggregation results. */
2737
2772
  ranges?: RangeResults;
2738
- /** Scalar aggregation results */
2773
+ /** Scalar aggregation results. */
2739
2774
  scalar?: AggregationResultsScalarResult;
2740
2775
  }
2741
2776
  interface ValueResults {
2742
2777
  /**
2743
- * List of value aggregations
2778
+ * Array of value aggregation results, each containing a field value and the count of entities with that value.
2744
2779
  * @maxSize 250
2745
2780
  */
2746
2781
  results?: ValueAggregationResult[];
2747
2782
  }
2748
2783
  interface RangeResults {
2749
2784
  /**
2750
- * List of ranges returned in same order as requested
2785
+ * Array of range aggregation results returned in the same order as requested, each containing range bounds and count of entities within that range.
2751
2786
  * @maxSize 50
2752
2787
  */
2753
2788
  results?: RangeAggregationResult[];
2754
2789
  }
2755
2790
  interface AggregationResultsScalarResult {
2756
- /** Type of scalar aggregation */
2791
+ /** Type of scalar aggregation. */
2757
2792
  type?: ScalarTypeWithLiterals;
2758
- /** Value of the scalar aggregation */
2793
+ /** Value of the scalar aggregation. */
2759
2794
  value?: number;
2760
2795
  }
2761
2796
  interface NestedValueAggregationResult {
2762
2797
  /**
2763
- * Value of the field
2798
+ * Value of the field.
2764
2799
  * @maxLength 1000
2765
2800
  */
2766
2801
  value?: string;
2767
- /** Nested aggregations */
2802
+ /** Nested aggregations. */
2768
2803
  nestedResults?: NestedAggregationResults;
2769
2804
  }
2770
2805
  interface ValueResult {
2771
2806
  /**
2772
- * Value of the field
2807
+ * Value of the field.
2773
2808
  * @maxLength 1000
2774
2809
  */
2775
2810
  value?: string;
2776
- /** Count of entities with this value */
2811
+ /** Count of entities with this value. */
2777
2812
  count?: number | null;
2778
2813
  }
2779
2814
  interface RangeResult {
2780
- /** Inclusive lower bound of the range */
2815
+ /** Inclusive lower bound of the range. */
2781
2816
  from?: number | null;
2782
- /** Exclusive upper bound of the range */
2817
+ /** Exclusive upper bound of the range. */
2783
2818
  to?: number | null;
2784
- /** Count of entities in this range */
2819
+ /** Count of entities in this range. */
2785
2820
  count?: number | null;
2786
2821
  }
2787
2822
  interface ScalarResult {
2788
- /** Value of the scalar aggregation */
2823
+ /** Value of the scalar aggregation. */
2789
2824
  value?: number;
2790
2825
  }
2791
2826
  interface NestedResultValue extends NestedResultValueResultOneOf {
2792
- /** Value aggregation result */
2827
+ /** Value aggregation result. */
2793
2828
  value?: ValueResult;
2794
- /** Range aggregation result */
2829
+ /** Range aggregation result. */
2795
2830
  range?: RangeResult;
2796
- /** Scalar aggregation result */
2831
+ /** Scalar aggregation result. */
2797
2832
  scalar?: ScalarResult;
2798
- /** Date histogram aggregation result */
2833
+ /** Date histogram aggregation result. */
2799
2834
  dateHistogram?: ValueResult;
2800
2835
  }
2801
2836
  /** @oneof */
2802
2837
  interface NestedResultValueResultOneOf {
2803
- /** Value aggregation result */
2838
+ /** Value aggregation result. */
2804
2839
  value?: ValueResult;
2805
- /** Range aggregation result */
2840
+ /** Range aggregation result. */
2806
2841
  range?: RangeResult;
2807
- /** Scalar aggregation result */
2842
+ /** Scalar aggregation result. */
2808
2843
  scalar?: ScalarResult;
2809
- /** Date histogram aggregation result */
2844
+ /** Date histogram aggregation result. */
2810
2845
  dateHistogram?: ValueResult;
2811
2846
  }
2812
2847
  interface Results {
2813
- /** List of nested aggregations */
2848
+ /** Map of nested aggregation results, keyed by aggregation name. */
2814
2849
  results?: Record<string, NestedResultValue>;
2815
2850
  }
2816
2851
  interface DateHistogramResult {
2817
2852
  /**
2818
- * Date in ISO 8601 format
2853
+ * Date in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
2819
2854
  * @maxLength 100
2820
2855
  */
2821
2856
  value?: string;
2822
- /** Count of documents in the bucket */
2857
+ /** Count of documents in the bucket. */
2823
2858
  count?: number;
2824
2859
  }
2825
2860
  interface GroupByValueResults {
2826
2861
  /**
2827
- * List of value aggregations
2862
+ * Array of nested value aggregation results, each containing a field value and the associated nested aggregation data.
2828
2863
  * @maxSize 1000
2829
2864
  */
2830
2865
  results?: NestedValueAggregationResult[];
2831
2866
  }
2832
2867
  interface DateHistogramResults {
2833
2868
  /**
2834
- * List of date histogram aggregations
2869
+ * Array of date histogram aggregation results, each containing a date bucket and its count.
2835
2870
  * @maxSize 200
2836
2871
  */
2837
2872
  results?: DateHistogramResult[];
2838
2873
  }
2839
2874
  /**
2840
- * Results of `NESTED` aggregation type in a flattened form
2841
- * aggregations in resulting array are keyed by requested aggregation `name`.
2875
+ * Results of `NESTED` aggregation type in a flattened form.
2876
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
2842
2877
  */
2843
2878
  interface NestedResults {
2844
2879
  /**
2845
- * List of nested aggregations
2880
+ * Array of nested aggregation result groups, each containing multiple aggregation results.
2846
2881
  * @maxSize 1000
2847
2882
  */
2848
2883
  results?: Results[];
2849
2884
  }
2850
2885
  interface AggregationResults extends AggregationResultsResultOneOf {
2851
- /** Value aggregation results */
2886
+ /** Value aggregation results. */
2852
2887
  values?: ValueResults;
2853
- /** Range aggregation results */
2888
+ /** Range aggregation results. */
2854
2889
  ranges?: RangeResults;
2855
- /** Scalar aggregation results */
2890
+ /** Scalar aggregation results. */
2856
2891
  scalar?: AggregationResultsScalarResult;
2857
- /** Group by value aggregation results */
2892
+ /** Group by value aggregation results. */
2858
2893
  groupedByValue?: GroupByValueResults;
2859
- /** Date histogram aggregation results */
2894
+ /** Date histogram aggregation results. */
2860
2895
  dateHistogram?: DateHistogramResults;
2861
- /** Nested aggregation results */
2896
+ /** Nested aggregation results. */
2862
2897
  nested?: NestedResults;
2863
2898
  /**
2864
- * User-defined name of aggregation as derived from search request
2899
+ * User-defined name of aggregation as derived from search request.
2865
2900
  * @maxLength 100
2866
2901
  */
2867
2902
  name?: string;
2868
- /** Type of aggregation that must match provided kind as derived from search request */
2903
+ /** Type of aggregation that must match specified kind as derived from search request. */
2869
2904
  type?: AggregationTypeWithLiterals;
2870
2905
  /**
2871
- * Field to aggregate by as derived from search request
2906
+ * Path to the field to aggregate by in dot notation. For example `appNamespace`.
2872
2907
  * @maxLength 200
2873
2908
  */
2874
2909
  fieldPath?: string;
2875
2910
  }
2876
2911
  /** @oneof */
2877
2912
  interface AggregationResultsResultOneOf {
2878
- /** Value aggregation results */
2913
+ /** Value aggregation results. */
2879
2914
  values?: ValueResults;
2880
- /** Range aggregation results */
2915
+ /** Range aggregation results. */
2881
2916
  ranges?: RangeResults;
2882
- /** Scalar aggregation results */
2917
+ /** Scalar aggregation results. */
2883
2918
  scalar?: AggregationResultsScalarResult;
2884
- /** Group by value aggregation results */
2919
+ /** Group by value aggregation results. */
2885
2920
  groupedByValue?: GroupByValueResults;
2886
- /** Date histogram aggregation results */
2921
+ /** Date histogram aggregation results. */
2887
2922
  dateHistogram?: DateHistogramResults;
2888
- /** Nested aggregation results */
2923
+ /** Nested aggregation results. */
2889
2924
  nested?: NestedResults;
2890
2925
  }
2891
2926
  interface DeprecatedSearchCategoriesWithOffsetRequest {
@@ -3503,6 +3538,20 @@ interface GetArrangedItemsResponse {
3503
3538
  */
3504
3539
  items?: ItemReference[];
3505
3540
  }
3541
+ interface SetItemCategoriesRequest {
3542
+ /** The item to update. */
3543
+ item: ItemReference;
3544
+ /**
3545
+ * List of category IDs to set for the item.
3546
+ * @format GUID
3547
+ * @maxSize 1000
3548
+ */
3549
+ categoryIds: string[];
3550
+ /** Category tree reference details. */
3551
+ treeReference: TreeReference;
3552
+ }
3553
+ interface SetItemCategoriesResponse {
3554
+ }
3506
3555
  interface GetCategoriesTreeRequest {
3507
3556
  /** Category tree reference details. */
3508
3557
  treeReference?: TreeReference;
@@ -3756,6 +3805,11 @@ type SetArrangedItemsApplicationErrors = {
3756
3805
  description?: string;
3757
3806
  data?: Record<string, any>;
3758
3807
  };
3808
+ type SetItemCategoriesApplicationErrors = {
3809
+ code?: 'MANAGED_CATEGORY_OPERATION_NOT_ALLOWED';
3810
+ description?: string;
3811
+ data?: Record<string, any>;
3812
+ };
3759
3813
  interface BaseEventMetadata {
3760
3814
  /**
3761
3815
  * App instance ID.
@@ -4017,7 +4071,6 @@ interface CategoryUpdatedEnvelope {
4017
4071
  * @slug updated
4018
4072
  */
4019
4073
  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
4074
  /**
4022
4075
  * Creates a category.
4023
4076
  * @param category - Category to create.
@@ -4032,7 +4085,7 @@ type CategoryNonNullablePaths = `itemCounter` | `breadcrumbsInfo.breadcrumbs` |
4032
4085
  * @returns Created category.
4033
4086
  * @fqn com.wix.categories.api.v1.CategoriesService.CreateCategory
4034
4087
  */
4035
- declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<Category, CategoryNonNullablePaths> & {
4088
+ declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`, 3>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6> & {
4036
4089
  __applicationErrorsType?: CreateCategoryApplicationErrors;
4037
4090
  }>;
4038
4091
  interface CreateCategoryOptions {
@@ -4058,7 +4111,7 @@ interface CreateCategoryOptions {
4058
4111
  * @returns Category.
4059
4112
  * @fqn com.wix.categories.api.v1.CategoriesService.GetCategory
4060
4113
  */
4061
- declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
4114
+ declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6>>;
4062
4115
  interface GetCategoryOptions {
4063
4116
  /**
4064
4117
  * Fields to include in the response.
@@ -4084,7 +4137,7 @@ interface GetCategoryOptions {
4084
4137
  * @returns Updated category.
4085
4138
  * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategory
4086
4139
  */
4087
- declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<Category, CategoryNonNullablePaths> & {
4140
+ declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`, 2>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6> & {
4088
4141
  __applicationErrorsType?: UpdateCategoryApplicationErrors;
4089
4142
  }>;
4090
4143
  interface UpdateCategory {
@@ -4165,6 +4218,8 @@ interface UpdateCategory {
4165
4218
  * @format URL_SLUG
4166
4219
  */
4167
4220
  slug?: string | null;
4221
+ /** Custom SEO data for the category. */
4222
+ seoData?: SeoSchema;
4168
4223
  /**
4169
4224
  * Category description using rich content.
4170
4225
  * > **Note:** Returned only when you pass `"RICH_CONTENT_DESCRIPTION"` to the `fields` array in Categories API requests.
@@ -4210,7 +4265,7 @@ interface UpdateCategoryOptions {
4210
4265
  * @applicableIdentity APP
4211
4266
  * @fqn com.wix.categories.api.v1.CategoriesService.DeleteCategory
4212
4267
  */
4213
- declare function deleteCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>): Promise<void & {
4268
+ declare function deleteCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>): Promise<void & {
4214
4269
  __applicationErrorsType?: DeleteCategoryApplicationErrors;
4215
4270
  }>;
4216
4271
  /**
@@ -4310,13 +4365,13 @@ interface SearchCategoriesOptions {
4310
4365
  */
4311
4366
  treeReference: TreeReference;
4312
4367
  /**
4313
- * Whether to return the categories with `visible: false`.
4368
+ * Whether to return the categories with `visible` set to `false`.
4314
4369
  *
4315
- * Default: `false` - only visible categories are returned in the response
4370
+ * Default: `false`. Only visible categories are returned in the response
4316
4371
  */
4317
4372
  returnNonVisibleCategories?: boolean;
4318
4373
  /**
4319
- * Fields to include in the response.
4374
+ * Array of projected fields. A list of specific field names to return.
4320
4375
  * @maxSize 100
4321
4376
  */
4322
4377
  fields?: RequestedFieldsWithLiterals[];
@@ -4366,8 +4421,8 @@ interface CategorySearchSpec extends SearchSpec {
4366
4421
  type CommonSearchWithEntityContext = Search<Category, CategorySearchSpec>;
4367
4422
  type CategorySearch = {
4368
4423
  /**
4369
- Cursor pointing to page of results.
4370
- When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
4424
+ Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
4425
+ `filter`, `sort`, or `search` can't be specified.
4371
4426
  */
4372
4427
  cursorPaging?: {
4373
4428
  /**
@@ -4385,11 +4440,17 @@ type CategorySearch = {
4385
4440
  cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
4386
4441
  };
4387
4442
  /**
4388
- A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
4443
+ Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
4444
+
4445
+ Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
4446
+ or the [supported filters article](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting) (REST).
4389
4447
  */
4390
4448
  filter?: CommonSearchWithEntityContext['filter'] | null;
4391
4449
  /**
4392
- Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4450
+ Array of sort objects specifying result order. For example, to sort by creation date in ascending order: `"sort": [{"fieldName": "createdDate", "order": "ASC"}]`.
4451
+
4452
+ Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
4453
+ or the [supported filters article](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting) (REST).
4393
4454
  @maxSize: 10
4394
4455
  */
4395
4456
  sort?: {
@@ -4404,51 +4465,52 @@ type CategorySearch = {
4404
4465
  order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
4405
4466
  }[];
4406
4467
  /**
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.
4468
+ Aggregations for grouping data into categories (facets) and providing summaries for each category.
4469
+ For example, use aggregations to categorize search results by service type, payment options, or locations.
4408
4470
  @maxSize: 10
4409
4471
  */
4410
4472
  aggregations?: {
4411
4473
  /**
4412
- Value aggregation
4474
+ Value aggregation configuration.
4413
4475
  */
4414
4476
  value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
4415
4477
  /**
4416
- Range aggregation
4478
+ Range aggregation configuration.
4417
4479
  */
4418
4480
  range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
4419
4481
  /**
4420
- Scalar aggregation
4482
+ Scalar aggregation configuration.
4421
4483
  */
4422
4484
  scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
4423
4485
  /**
4424
- Date histogram aggregation
4486
+ Date histogram aggregation configuration.
4425
4487
  */
4426
4488
  dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
4427
4489
  /**
4428
- Nested aggregation
4490
+ Nested aggregation configuration.
4429
4491
  */
4430
4492
  nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
4431
4493
  /**
4432
- User-defined name of aggregation, should be unique, will appear in aggregation results
4494
+ User-defined name of aggregation. Must be unique and will appear in aggregation results.
4433
4495
  @maxLength: 100
4434
4496
  */
4435
4497
  name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
4436
4498
  /**
4437
- Type of aggregation, client must provide matching aggregation field below
4499
+ Type of aggregation. Client must specify matching aggregation field below.
4438
4500
  */
4439
4501
  type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
4440
4502
  /**
4441
- Field to aggregate by, use dot notation to specify json path
4503
+ Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
4442
4504
  @maxLength: 200
4443
4505
  */
4444
4506
  fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
4445
4507
  }[];
4446
4508
  /**
4447
- Free text to match in searchable fields
4509
+ Free text to match in searchable fields.
4448
4510
  */
4449
4511
  search?: {
4450
4512
  /**
4451
- Defines how separate search terms in `expression` are combined.
4513
+ Search mode. Defines the search logic for combining multiple terms in the `expression`.
4452
4514
  */
4453
4515
  mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
4454
4516
  /**
@@ -4457,26 +4519,20 @@ type CategorySearch = {
4457
4519
  */
4458
4520
  expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
4459
4521
  /**
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.
4522
+ Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `parentCategory.index`.
4463
4523
  @maxLength: 200,
4464
4524
  @maxSize: 20
4465
4525
  */
4466
4526
  fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
4467
4527
  /**
4468
- Whether to use fuzzy search - allowing typos and other minor errors in the search.
4528
+ Whether to enable the search method to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions.
4469
4529
  */
4470
4530
  fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
4471
4531
  };
4472
4532
  /**
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
4533
+ Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) or [ISO 8601 UTC offset format](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC) for adjusting time fields in the specified filters and returned aggregation data. For example, `America/New_York`, `UTC`, or `+02:00`.
4476
4534
 
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"`
4535
+ Default: Time zone specified in the business site properties ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties) | [REST](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties)).
4480
4536
  @maxLength: 50
4481
4537
  */
4482
4538
  timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
@@ -4494,7 +4550,7 @@ type CategorySearch = {
4494
4550
  * @applicableIdentity VISITOR
4495
4551
  * @fqn com.wix.categories.api.v1.CategoriesService.CountCategories
4496
4552
  */
4497
- declare function countCategories(options?: NonNullablePaths<CountCategoriesOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<CountCategoriesResponse, `count`>>;
4553
+ declare function countCategories(options?: NonNullablePaths<CountCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<CountCategoriesResponse, `count`, 2>>;
4498
4554
  interface CountCategoriesOptions {
4499
4555
  /**
4500
4556
  * Filter object.
@@ -4526,7 +4582,7 @@ interface CountCategoriesOptions {
4526
4582
  * @applicableIdentity APP
4527
4583
  * @fqn com.wix.categories.api.v1.CategoriesService.MoveCategory
4528
4584
  */
4529
- declare function moveCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: NonNullablePaths<MoveCategoryOptions, `position`>): Promise<NonNullablePaths<MoveCategoryResponse, `categoriesAfterMove`> & {
4585
+ declare function moveCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: NonNullablePaths<MoveCategoryOptions, `position`, 2>): Promise<NonNullablePaths<MoveCategoryResponse, `categoriesAfterMove`, 2> & {
4530
4586
  __applicationErrorsType?: MoveCategoryApplicationErrors;
4531
4587
  }>;
4532
4588
  interface MoveCategoryOptions {
@@ -4569,9 +4625,7 @@ interface MoveCategoryOptions {
4569
4625
  * @applicableIdentity APP
4570
4626
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkUpdateCategories
4571
4627
  */
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`> & {
4628
+ declare function bulkUpdateCategories(categories: NonNullablePaths<MaskedCategory, `category` | `category._id` | `category.revision`, 3>[], options?: NonNullablePaths<BulkUpdateCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkUpdateCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
4575
4629
  __applicationErrorsType?: BulkUpdateCategoriesApplicationErrors;
4576
4630
  }>;
4577
4631
  interface BulkUpdateCategoriesOptions {
@@ -4607,9 +4661,7 @@ interface BulkUpdateCategoriesOptions {
4607
4661
  * @applicableIdentity APP
4608
4662
  * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategoryVisibility
4609
4663
  */
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]> & {
4664
+ declare function updateCategoryVisibility(categoryId: string, options?: NonNullablePaths<UpdateCategoryVisibilityOptions, `revision` | `treeReference` | `treeReference.appNamespace` | `visible`, 3>): Promise<NonNullablePaths<UpdateCategoryVisibilityResponse, `category.itemCounter` | `category.breadcrumbsInfo.breadcrumbs` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `category.breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `category.seoData.tags` | `category.seoData.tags.${number}.type` | `category.seoData.tags.${number}.children` | `category.seoData.tags.${number}.custom` | `category.seoData.tags.${number}.disabled` | `category.seoData.settings.preventAutoRedirect` | `category.seoData.settings.keywords` | `category.seoData.settings.keywords.${number}.term` | `category.seoData.settings.keywords.${number}.isMain`, 7> & {
4613
4665
  __applicationErrorsType?: UpdateCategoryVisibilityApplicationErrors;
4614
4666
  }>;
4615
4667
  interface UpdateCategoryVisibilityOptions {
@@ -4647,9 +4699,7 @@ interface UpdateCategoryVisibilityOptions {
4647
4699
  * @applicableIdentity APP
4648
4700
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkShowCategories
4649
4701
  */
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`>>;
4702
+ declare function bulkShowCategories(categoryIds: string[], options?: NonNullablePaths<BulkShowCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkShowCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
4653
4703
  interface BulkShowCategoriesOptions {
4654
4704
  /** Category tree reference details. */
4655
4705
  treeReference: TreeReference;
@@ -4681,7 +4731,7 @@ interface BulkShowCategoriesOptions {
4681
4731
  * @applicableIdentity APP
4682
4732
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkAddItemsToCategory
4683
4733
  */
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`> & {
4734
+ declare function bulkAddItemsToCategory(categoryId: string, items: NonNullablePaths<ItemReference, `appId` | `catalogItemId`, 2>[], options: NonNullablePaths<BulkAddItemsToCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): 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`, 6> & {
4685
4735
  __applicationErrorsType?: BulkAddItemsToCategoryApplicationErrors;
4686
4736
  }>;
4687
4737
  interface BulkAddItemsToCategoryOptions {
@@ -4703,7 +4753,7 @@ interface BulkAddItemsToCategoryOptions {
4703
4753
  * @applicableIdentity APP
4704
4754
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkAddItemToCategories
4705
4755
  */
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`> & {
4756
+ declare function bulkAddItemToCategories(item: NonNullablePaths<ItemReference, `appId` | `catalogItemId`, 2>, options: NonNullablePaths<BulkAddItemToCategoriesOptions, `categoryIds` | `treeReference` | `treeReference.appNamespace`, 3>): 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`, 6> & {
4707
4757
  __applicationErrorsType?: BulkAddItemToCategoriesApplicationErrors;
4708
4758
  }>;
4709
4759
  interface BulkAddItemToCategoriesOptions {
@@ -4733,7 +4783,7 @@ interface BulkAddItemToCategoriesOptions {
4733
4783
  * @applicableIdentity APP
4734
4784
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkRemoveItemsFromCategory
4735
4785
  */
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`> & {
4786
+ declare function bulkRemoveItemsFromCategory(categoryId: string, items: NonNullablePaths<ItemReference, `appId` | `catalogItemId`, 2>[], options: NonNullablePaths<BulkRemoveItemsFromCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): 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`, 6> & {
4737
4787
  __applicationErrorsType?: BulkRemoveItemsFromCategoryApplicationErrors;
4738
4788
  }>;
4739
4789
  interface BulkRemoveItemsFromCategoryOptions {
@@ -4755,7 +4805,7 @@ interface BulkRemoveItemsFromCategoryOptions {
4755
4805
  * @applicableIdentity APP
4756
4806
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkRemoveItemFromCategories
4757
4807
  */
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`> & {
4808
+ declare function bulkRemoveItemFromCategories(item: NonNullablePaths<ItemReference, `appId` | `catalogItemId`, 2>, options: NonNullablePaths<BulkRemoveItemFromCategoriesOptions, `categoryIds` | `treeReference` | `treeReference.appNamespace`, 3>): 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`, 6> & {
4759
4809
  __applicationErrorsType?: BulkRemoveItemFromCategoriesApplicationErrors;
4760
4810
  }>;
4761
4811
  interface BulkRemoveItemFromCategoriesOptions {
@@ -4785,7 +4835,7 @@ interface BulkRemoveItemFromCategoriesOptions {
4785
4835
  * @applicableIdentity VISITOR
4786
4836
  * @fqn com.wix.categories.api.v1.CategoriesService.ListItemsInCategory
4787
4837
  */
4788
- declare function listItemsInCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: ListItemsInCategoryOptions): Promise<NonNullablePaths<ListItemsInCategoryResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`>>;
4838
+ declare function listItemsInCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: ListItemsInCategoryOptions): Promise<NonNullablePaths<ListItemsInCategoryResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4>>;
4789
4839
  interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMethodOneOf {
4790
4840
  /**
4791
4841
  * Whether to use category arrangement for sorting items.
@@ -4828,7 +4878,7 @@ interface ListItemsInCategoryOptionsPagingMethodOneOf {
4828
4878
  * @applicableIdentity VISITOR
4829
4879
  * @fqn com.wix.categories.api.v1.CategoriesService.ListCategoriesForItem
4830
4880
  */
4831
- declare function listCategoriesForItem(item: ItemReference, options: NonNullablePaths<ListCategoriesForItemOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<ListCategoriesForItemResponse, `directCategoryIds` | `allCategoryIds`>>;
4881
+ declare function listCategoriesForItem(item: ItemReference, options: NonNullablePaths<ListCategoriesForItemOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<ListCategoriesForItemResponse, `directCategoryIds` | `allCategoryIds`, 2>>;
4832
4882
  interface ListCategoriesForItemOptions {
4833
4883
  /** Category tree reference details. */
4834
4884
  treeReference: TreeReference;
@@ -4848,7 +4898,7 @@ interface ListCategoriesForItemOptions {
4848
4898
  * @applicableIdentity VISITOR
4849
4899
  * @fqn com.wix.categories.api.v1.CategoriesService.ListCategoriesForItems
4850
4900
  */
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`>>;
4901
+ declare function listCategoriesForItems(items: NonNullablePaths<ItemReference, `appId` | `catalogItemId`, 2>[], options: NonNullablePaths<ListCategoriesForItemsOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<ListCategoriesForItemsResponse, `categoriesForItems` | `categoriesForItems.${number}.item.catalogItemId` | `categoriesForItems.${number}.item.appId`, 5>>;
4852
4902
  interface ListCategoriesForItemsOptions {
4853
4903
  /** Category tree reference details. */
4854
4904
  treeReference: TreeReference;
@@ -4861,7 +4911,7 @@ interface ListCategoriesForItemsOptions {
4861
4911
  * @applicableIdentity VISITOR
4862
4912
  * @fqn com.wix.categories.api.v1.CategoriesService.ListTrees
4863
4913
  */
4864
- declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees` | `trees.${number}.appNamespace`>>;
4914
+ declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees` | `trees.${number}.appNamespace`, 4>>;
4865
4915
  /**
4866
4916
  * Sets arranged items in a category.
4867
4917
  *
@@ -4877,7 +4927,7 @@ declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees
4877
4927
  * @applicableIdentity APP
4878
4928
  * @fqn com.wix.categories.api.v1.CategoriesService.SetArrangedItems
4879
4929
  */
4880
- declare function setArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: SetArrangedItemsOptions): Promise<NonNullablePaths<SetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`> & {
4930
+ declare function setArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: SetArrangedItemsOptions): Promise<NonNullablePaths<SetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4> & {
4881
4931
  __applicationErrorsType?: SetArrangedItemsApplicationErrors;
4882
4932
  }>;
4883
4933
  interface SetArrangedItemsOptions {
@@ -4900,6 +4950,16 @@ interface SetArrangedItemsOptions {
4900
4950
  * @applicableIdentity VISITOR
4901
4951
  * @fqn com.wix.categories.api.v1.CategoriesService.GetArrangedItems
4902
4952
  */
4903
- declare function getArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>): Promise<NonNullablePaths<GetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`>>;
4953
+ declare function getArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>): Promise<NonNullablePaths<GetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4>>;
4954
+ interface SetItemCategoriesOptions {
4955
+ /**
4956
+ * List of category IDs to set for the item.
4957
+ * @format GUID
4958
+ * @maxSize 1000
4959
+ */
4960
+ categoryIds: string[];
4961
+ /** Category tree reference details. */
4962
+ treeReference: TreeReference;
4963
+ }
4904
4964
 
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 };
4965
+ 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 TypeWithLiterals 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 PluginContainerDataAlignmentWithLiterals as eA, type ButtonDataTypeWithLiterals as eB, type TargetWithLiterals as eC, type TextAlignmentWithLiterals as eD, type LineStyleWithLiterals as eE, type WidthWithLiterals as eF, type DividerDataAlignmentWithLiterals as eG, type ViewModeWithLiterals as eH, type LayoutTypeWithLiterals as eI, type OrientationWithLiterals as eJ, type CropWithLiterals as eK, type ThumbnailsAlignmentWithLiterals as eL, type GIFTypeWithLiterals as eM, type SourceWithLiterals as eN, type StylesPositionWithLiterals as eO, type MapTypeWithLiterals as eP, type ViewRoleWithLiterals as eQ, type VoteRoleWithLiterals as eR, type PollLayoutTypeWithLiterals as eS, type PollLayoutDirectionWithLiterals as eT, type BackgroundTypeWithLiterals as eU, type DecorationTypeWithLiterals as eV, type FontTypeWithLiterals as eW, type ImageStylesPositionWithLiterals as eX, type AspectRatioWithLiterals as eY, type ResizingWithLiterals as eZ, type PlacementWithLiterals as e_, type SetArrangedItemsRequest as ea, type GetArrangedItemsRequest as eb, type SetItemCategoriesRequest as ec, type SetItemCategoriesResponse as ed, type GetCategoriesTreeRequest as ee, type GetCategoriesTreeResponse as ef, type CategoryTreeNode as eg, type DomainEvent as eh, type DomainEventBodyOneOf as ei, type EntityCreatedEvent as ej, type RestoreInfo as ek, type EntityUpdatedEvent as el, type EntityDeletedEvent as em, type ActionEvent as en, type Empty as eo, type MessageEnvelope as ep, type IdentificationData as eq, type IdentificationDataIdOneOf as er, type BaseEventMetadata as es, type EventMetadata as et, type CategoriesQueryResult as eu, type CategorySearchSpec as ev, type ListItemsInCategoryOptionsPagingMethodOneOf as ew, type SetItemCategoriesOptions as ex, type NodeTypeWithLiterals as ey, type WidthTypeWithLiterals as ez, type CategorySearch as f, type AlignmentWithLiterals as f0, type LayoutWithLiterals as f1, type AppTypeWithLiterals as f2, type InitialExpandedItemsWithLiterals as f3, type DirectionWithLiterals as f4, type VerticalAlignmentWithLiterals as f5, type NullValueWithLiterals as f6, type SingleEntityOpsRequestedFieldsWithLiterals as f7, type SortOrderWithLiterals as f8, type RequestedFieldsWithLiterals as f9, moveCategory as fA, bulkUpdateCategories as fB, updateCategoryVisibility as fC, bulkShowCategories as fD, bulkAddItemsToCategory as fE, bulkAddItemToCategories as fF, bulkRemoveItemsFromCategory as fG, bulkRemoveItemFromCategories as fH, listItemsInCategory as fI, listCategoriesForItem as fJ, listCategoriesForItems as fK, listTrees as fL, setArrangedItems as fM, getArrangedItems as fN, type SortTypeWithLiterals as fa, type SortDirectionWithLiterals as fb, type MissingValuesWithLiterals as fc, type ScalarTypeWithLiterals as fd, type NestedAggregationTypeWithLiterals as fe, type IntervalWithLiterals as ff, type AggregationTypeWithLiterals as fg, type ModeWithLiterals as fh, type PositionWithLiterals as fi, type MoveItemInCategoryRequestPositionWithLiterals as fj, type WebhookIdentityTypeWithLiterals as fk, type SetItemCategoriesApplicationErrors as fl, type CommonSearchWithEntityContext as fm, onCategoryMoved as fn, onCategoryCreated as fo, onCategoryDeleted as fp, onCategoryItemAddedToCategory as fq, onCategoryItemRemovedFromCategory as fr, onCategoryItemsArrangedInCategory as fs, onCategoryUpdated as ft, createCategory as fu, getCategory as fv, updateCategory as fw, deleteCategory as fx, queryCategories as fy, countCategories 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 };