@wix/auto_sdk_categories_categories 1.0.62 → 1.0.64

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 (29) hide show
  1. package/build/cjs/{categories-v1-category-categories.universal-CAAW-EQ5.d.ts → categories-v1-category-categories.universal-D3bNXid_.d.ts} +260 -246
  2. package/build/cjs/index.d.ts +48 -43
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +28 -15
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +264 -142
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/es/{categories-v1-category-categories.universal-CAAW-EQ5.d.mts → categories-v1-category-categories.universal-D3bNXid_.d.mts} +260 -246
  9. package/build/es/index.d.mts +48 -43
  10. package/build/es/index.mjs.map +1 -1
  11. package/build/es/index.typings.d.mts +28 -15
  12. package/build/es/index.typings.mjs.map +1 -1
  13. package/build/es/meta.d.mts +264 -142
  14. package/build/es/meta.mjs.map +1 -1
  15. package/build/internal/cjs/{categories-v1-category-categories.universal-CAAW-EQ5.d.ts → categories-v1-category-categories.universal-D3bNXid_.d.ts} +260 -246
  16. package/build/internal/cjs/index.d.ts +48 -43
  17. package/build/internal/cjs/index.js.map +1 -1
  18. package/build/internal/cjs/index.typings.d.ts +28 -15
  19. package/build/internal/cjs/index.typings.js.map +1 -1
  20. package/build/internal/cjs/meta.d.ts +264 -142
  21. package/build/internal/cjs/meta.js.map +1 -1
  22. package/build/internal/es/{categories-v1-category-categories.universal-CAAW-EQ5.d.mts → categories-v1-category-categories.universal-D3bNXid_.d.mts} +260 -246
  23. package/build/internal/es/index.d.mts +48 -43
  24. package/build/internal/es/index.mjs.map +1 -1
  25. package/build/internal/es/index.typings.d.mts +28 -15
  26. package/build/internal/es/index.typings.mjs.map +1 -1
  27. package/build/internal/es/meta.d.mts +264 -142
  28. package/build/internal/es/meta.mjs.map +1 -1
  29. 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.
@@ -1433,6 +1435,8 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1433
1435
  cardStyles?: CardStyles;
1434
1436
  /** Styling for the app embed's container. */
1435
1437
  containerData?: PluginContainerData;
1438
+ /** Pricing data for embedded Wix App content. */
1439
+ pricingData?: PricingData;
1436
1440
  }
1437
1441
  /** @oneof */
1438
1442
  interface AppEmbedDataAppDataOneOf {
@@ -1634,6 +1638,33 @@ interface CardStyles {
1634
1638
  */
1635
1639
  textColor?: string | null;
1636
1640
  }
1641
+ interface PricingData {
1642
+ /**
1643
+ * Minimum numeric price value as string (e.g., "10.99").
1644
+ * @decimalValue options { maxScale:2 }
1645
+ */
1646
+ valueFrom?: string | null;
1647
+ /**
1648
+ * Maximum numeric price value as string (e.g., "19.99").
1649
+ * @decimalValue options { maxScale:2 }
1650
+ */
1651
+ valueTo?: string | null;
1652
+ /**
1653
+ * Numeric price value as string after discount application (e.g., "15.99").
1654
+ * @decimalValue options { maxScale:2 }
1655
+ */
1656
+ discountedValue?: string | null;
1657
+ /**
1658
+ * Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
1659
+ * @format CURRENCY
1660
+ */
1661
+ currency?: string | null;
1662
+ /**
1663
+ * Pricing plan ID.
1664
+ * @format GUID
1665
+ */
1666
+ pricingPlanId?: string | null;
1667
+ }
1637
1668
  interface VideoData {
1638
1669
  /** Styling for the video's container. */
1639
1670
  containerData?: PluginContainerData;
@@ -2349,7 +2380,13 @@ interface CompactCategory {
2349
2380
  name?: string | null;
2350
2381
  }
2351
2382
  interface SearchCategoriesRequest {
2352
- /** 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
+ */
2353
2390
  search?: CursorSearch;
2354
2391
  /**
2355
2392
  * Category tree reference details.
@@ -2357,45 +2394,50 @@ interface SearchCategoriesRequest {
2357
2394
  */
2358
2395
  treeReference: TreeReference;
2359
2396
  /**
2360
- * Whether to return the categories with `visible: false`.
2397
+ * Whether to return the categories with `visible` set to `false`.
2361
2398
  *
2362
- * Default: `false` - only visible categories are returned in the response
2399
+ * Default: `false`. Only visible categories are returned in the response
2363
2400
  */
2364
2401
  returnNonVisibleCategories?: boolean;
2365
2402
  /**
2366
- * Fields to include in the response.
2403
+ * Array of projected fields. A list of specific field names to return.
2367
2404
  * @maxSize 100
2368
2405
  */
2369
2406
  fields?: RequestedFieldsWithLiterals[];
2370
2407
  }
2371
2408
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
2372
2409
  /**
2373
- * Cursor pointing to page of results.
2374
- * 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.
2375
2412
  */
2376
2413
  cursorPaging?: CursorPaging;
2377
- /** 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
+ */
2378
2420
  filter?: Record<string, any> | null;
2379
2421
  /**
2380
- * 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).
2381
2426
  * @maxSize 10
2382
2427
  */
2383
2428
  sort?: Sorting[];
2384
2429
  /**
2385
- * 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.
2386
2432
  * @maxSize 10
2387
2433
  */
2388
2434
  aggregations?: Aggregation[];
2389
- /** Free text to match in searchable fields */
2435
+ /** Free text to match in searchable fields. */
2390
2436
  search?: SearchDetails;
2391
2437
  /**
2392
- * UTC offset or IANA time zone. Valid values are
2393
- * ISO 8601 UTC offsets, such as +02:00 or -06:00,
2394
- * 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`.
2395
2439
  *
2396
- * Affects all filters and aggregations returned values.
2397
- * You may override this behavior in a specific filter by providing
2398
- * 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)).
2399
2441
  * @maxLength 50
2400
2442
  */
2401
2443
  timeZone?: string | null;
@@ -2403,52 +2445,52 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
2403
2445
  /** @oneof */
2404
2446
  interface CursorSearchPagingMethodOneOf {
2405
2447
  /**
2406
- * Cursor pointing to page of results.
2407
- * 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.
2408
2450
  */
2409
2451
  cursorPaging?: CursorPaging;
2410
2452
  }
2411
2453
  interface Aggregation extends AggregationKindOneOf {
2412
- /** Value aggregation */
2454
+ /** Value aggregation configuration. */
2413
2455
  value?: ValueAggregation;
2414
- /** Range aggregation */
2456
+ /** Range aggregation configuration. */
2415
2457
  range?: RangeAggregation;
2416
- /** Scalar aggregation */
2458
+ /** Scalar aggregation configuration. */
2417
2459
  scalar?: ScalarAggregation;
2418
- /** Date histogram aggregation */
2460
+ /** Date histogram aggregation configuration. */
2419
2461
  dateHistogram?: DateHistogramAggregation;
2420
- /** Nested aggregation */
2462
+ /** Nested aggregation configuration. */
2421
2463
  nested?: NestedAggregation;
2422
2464
  /**
2423
- * 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.
2424
2466
  * @maxLength 100
2425
2467
  */
2426
2468
  name?: string | null;
2427
- /** Type of aggregation, client must provide matching aggregation field below */
2469
+ /** Type of aggregation. Client must specify matching aggregation field below. */
2428
2470
  type?: AggregationTypeWithLiterals;
2429
2471
  /**
2430
- * 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`.
2431
2473
  * @maxLength 200
2432
2474
  */
2433
2475
  fieldPath?: string;
2434
2476
  }
2435
2477
  /** @oneof */
2436
2478
  interface AggregationKindOneOf {
2437
- /** Value aggregation */
2479
+ /** Value aggregation configuration. */
2438
2480
  value?: ValueAggregation;
2439
- /** Range aggregation */
2481
+ /** Range aggregation configuration. */
2440
2482
  range?: RangeAggregation;
2441
- /** Scalar aggregation */
2483
+ /** Scalar aggregation configuration. */
2442
2484
  scalar?: ScalarAggregation;
2443
- /** Date histogram aggregation */
2485
+ /** Date histogram aggregation configuration. */
2444
2486
  dateHistogram?: DateHistogramAggregation;
2445
- /** Nested aggregation */
2487
+ /** Nested aggregation configuration. */
2446
2488
  nested?: NestedAggregation;
2447
2489
  }
2448
2490
  interface RangeBucket {
2449
- /** 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. */
2450
2492
  from?: number | null;
2451
- /** 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. */
2452
2494
  to?: number | null;
2453
2495
  }
2454
2496
  declare enum SortType {
@@ -2460,9 +2502,9 @@ declare enum SortType {
2460
2502
  /** @enumType */
2461
2503
  type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
2462
2504
  declare enum SortDirection {
2463
- /** Sort in descending order. */
2505
+ /** Descending order. */
2464
2506
  DESC = "DESC",
2465
- /** Sort in ascending order. */
2507
+ /** Ascending order. */
2466
2508
  ASC = "ASC"
2467
2509
  }
2468
2510
  /** @enumType */
@@ -2470,21 +2512,26 @@ type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
2470
2512
  declare enum MissingValues {
2471
2513
  /** Exclude missing values from the aggregation results. */
2472
2514
  EXCLUDE = "EXCLUDE",
2473
- /** Included missing values in the aggregation results. */
2515
+ /** Include missing values in the aggregation results. */
2474
2516
  INCLUDE = "INCLUDE"
2475
2517
  }
2476
2518
  /** @enumType */
2477
2519
  type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
2478
2520
  interface IncludeMissingValuesOptions {
2479
2521
  /**
2480
- * 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`
2481
2528
  * @maxLength 20
2482
2529
  */
2483
2530
  addToBucket?: string;
2484
2531
  }
2485
2532
  declare enum ScalarType {
2486
2533
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
2487
- /** Count of distinct values. */
2534
+ /** Total number of distinct values. */
2488
2535
  COUNT_DISTINCT = "COUNT_DISTINCT",
2489
2536
  /** Minimum value. */
2490
2537
  MIN = "MIN",
@@ -2494,132 +2541,139 @@ declare enum ScalarType {
2494
2541
  /** @enumType */
2495
2542
  type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
2496
2543
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
2497
- /** Options for including missing values */
2544
+ /** Options for including missing values in the aggregation results. */
2498
2545
  includeOptions?: IncludeMissingValuesOptions;
2499
- /** Type of sort to perform. */
2546
+ /** Whether to sort by number of matches or value of the field. */
2500
2547
  sortType?: SortTypeWithLiterals;
2501
- /** Direction to sort in. */
2548
+ /** Whether to sort in ascending or descending order. */
2502
2549
  sortDirection?: SortDirectionWithLiterals;
2503
- /** 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
+ */
2504
2557
  limit?: number | null;
2505
2558
  /**
2506
- * Whether missing values are included in the aggregation results.
2559
+ * Whether missing values should be included or excluded from the aggregation results.
2560
+ *
2507
2561
  * Default: `EXCLUDE`
2508
2562
  */
2509
2563
  missingValues?: MissingValuesWithLiterals;
2510
2564
  }
2511
2565
  /** @oneof */
2512
2566
  interface ValueAggregationOptionsOneOf {
2513
- /** Options for including missing values */
2567
+ /** Options for including missing values in the aggregation results. */
2514
2568
  includeOptions?: IncludeMissingValuesOptions;
2515
2569
  }
2516
2570
  declare enum NestedAggregationType {
2517
2571
  /** Unknown aggregation type. */
2518
2572
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2519
- /** 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. */
2520
2574
  VALUE = "VALUE",
2521
- /** 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. */
2522
2576
  RANGE = "RANGE",
2523
- /** 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`. */
2524
2578
  SCALAR = "SCALAR",
2525
- /** 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.). */
2526
2580
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
2527
2581
  }
2528
2582
  /** @enumType */
2529
2583
  type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
2530
2584
  interface RangeAggregation {
2531
2585
  /**
2532
- * 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.
2533
2587
  * @maxSize 50
2534
2588
  */
2535
2589
  buckets?: RangeBucket[];
2536
2590
  }
2537
2591
  interface ScalarAggregation {
2538
- /** Define the operator for the scalar aggregation */
2592
+ /** Operator for the scalar aggregation, for example `COUNT_DISTINCT`, `MIN`, `MAX`. */
2539
2593
  type?: ScalarTypeWithLiterals;
2540
2594
  }
2541
2595
  interface DateHistogramAggregation {
2542
- /** Interval for date histogram aggregation */
2596
+ /** Time interval for date histogram aggregation, for example `DAY`, `HOUR`, `MONTH`. */
2543
2597
  interval?: IntervalWithLiterals;
2544
2598
  }
2545
2599
  declare enum Interval {
2546
2600
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
2547
- /** Yearly interval */
2601
+ /** Yearly interval. */
2548
2602
  YEAR = "YEAR",
2549
- /** Monthly interval */
2603
+ /** Monthly interval. */
2550
2604
  MONTH = "MONTH",
2551
- /** Weekly interval */
2605
+ /** Weekly interval. */
2552
2606
  WEEK = "WEEK",
2553
- /** Daily interval */
2607
+ /** Daily interval. */
2554
2608
  DAY = "DAY",
2555
- /** Hourly interval */
2609
+ /** Hourly interval. */
2556
2610
  HOUR = "HOUR",
2557
- /** Minute interval */
2611
+ /** Minute interval. */
2558
2612
  MINUTE = "MINUTE",
2559
- /** Second interval */
2613
+ /** Second interval. */
2560
2614
  SECOND = "SECOND"
2561
2615
  }
2562
2616
  /** @enumType */
2563
2617
  type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
2564
2618
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
2565
- /** Value aggregation */
2619
+ /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
2566
2620
  value?: ValueAggregation;
2567
- /** Range aggregation */
2621
+ /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
2568
2622
  range?: RangeAggregation;
2569
- /** Scalar aggregation */
2623
+ /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
2570
2624
  scalar?: ScalarAggregation;
2571
- /** Date histogram aggregation */
2625
+ /** Date histogram aggregation configuration. Calculates counts within time intervals. */
2572
2626
  dateHistogram?: DateHistogramAggregation;
2573
2627
  /**
2574
- * 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.
2575
2629
  * @maxLength 100
2576
2630
  */
2577
2631
  name?: string | null;
2578
- /** Type of aggregation client must provide matching aggregation field below */
2632
+ /** Type of aggregation. Client must specify matching aggregation field below. */
2579
2633
  type?: NestedAggregationTypeWithLiterals;
2580
2634
  /**
2581
- * 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`.
2582
2636
  * @maxLength 200
2583
2637
  */
2584
2638
  fieldPath?: string;
2585
2639
  }
2586
2640
  /** @oneof */
2587
2641
  interface NestedAggregationItemKindOneOf {
2588
- /** Value aggregation */
2642
+ /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
2589
2643
  value?: ValueAggregation;
2590
- /** Range aggregation */
2644
+ /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
2591
2645
  range?: RangeAggregation;
2592
- /** Scalar aggregation */
2646
+ /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
2593
2647
  scalar?: ScalarAggregation;
2594
- /** Date histogram aggregation */
2648
+ /** Date histogram aggregation configuration. Calculates counts within time intervals. */
2595
2649
  dateHistogram?: DateHistogramAggregation;
2596
2650
  }
2597
2651
  declare enum AggregationType {
2598
2652
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2599
- /** 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. */
2600
2654
  VALUE = "VALUE",
2601
- /** 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. */
2602
2656
  RANGE = "RANGE",
2603
- /** 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`. */
2604
2658
  SCALAR = "SCALAR",
2605
- /** 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.). */
2606
2660
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
2607
- /** 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. */
2608
2662
  NESTED = "NESTED"
2609
2663
  }
2610
2664
  /** @enumType */
2611
2665
  type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
2612
- /** 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. */
2613
2667
  interface NestedAggregation {
2614
2668
  /**
2615
- * 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.
2616
2670
  * @minSize 2
2617
2671
  * @maxSize 3
2618
2672
  */
2619
2673
  nestedAggregations?: NestedAggregationItem[];
2620
2674
  }
2621
2675
  interface SearchDetails {
2622
- /** Defines how separate search terms in `expression` are combined. */
2676
+ /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
2623
2677
  mode?: ModeWithLiterals;
2624
2678
  /**
2625
2679
  * Search term or expression.
@@ -2627,18 +2681,16 @@ interface SearchDetails {
2627
2681
  */
2628
2682
  expression?: string | null;
2629
2683
  /**
2630
- * Fields in which to search for the `expression`. Use dot notation to specify field path.
2631
- *
2632
- * 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`.
2633
2685
  * @maxLength 200
2634
2686
  * @maxSize 20
2635
2687
  */
2636
2688
  fields?: string[];
2637
- /** 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. */
2638
2690
  fuzzy?: boolean;
2639
2691
  }
2640
2692
  declare enum Mode {
2641
- /** Any of the search terms must be present. */
2693
+ /** At least 1 of the search terms must be present. */
2642
2694
  OR = "OR",
2643
2695
  /** All search terms must be present. */
2644
2696
  AND = "AND"
@@ -2647,18 +2699,30 @@ declare enum Mode {
2647
2699
  type ModeWithLiterals = Mode | 'OR' | 'AND';
2648
2700
  interface SearchCategoriesResponse {
2649
2701
  /**
2650
- * List of categories.
2702
+ * Retrieved categories that match the search criteria specified in the request.
2703
+ *
2704
+ * Each category includes all standard category information.
2651
2705
  * @maxSize 1000
2652
2706
  */
2653
2707
  categories?: Category[];
2654
- /** 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
+ */
2655
2714
  pagingMetadata?: CursorPagingMetadata;
2656
- /** 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
+ */
2657
2721
  aggregationData?: AggregationData;
2658
2722
  }
2659
2723
  interface AggregationData {
2660
2724
  /**
2661
- * 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.
2662
2726
  * @maxSize 10000
2663
2727
  */
2664
2728
  results?: AggregationResults[];
@@ -2673,190 +2737,190 @@ interface ValueAggregationResult {
2673
2737
  count?: number;
2674
2738
  }
2675
2739
  interface RangeAggregationResult {
2676
- /** Inclusive lower bound of the range */
2740
+ /** Inclusive lower bound of the range. */
2677
2741
  from?: number | null;
2678
- /** Exclusive upper bound of the range */
2742
+ /** Exclusive upper bound of the range. */
2679
2743
  to?: number | null;
2680
- /** Count of entities in this range */
2744
+ /** Count of entities in this range. */
2681
2745
  count?: number;
2682
2746
  }
2683
2747
  interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
2684
- /** Value aggregation results */
2748
+ /** Value aggregation results. */
2685
2749
  values?: ValueResults;
2686
- /** Range aggregation results */
2750
+ /** Range aggregation results. */
2687
2751
  ranges?: RangeResults;
2688
- /** Scalar aggregation results */
2752
+ /** Scalar aggregation results. */
2689
2753
  scalar?: AggregationResultsScalarResult;
2690
2754
  /**
2691
- * User-defined name of aggregation, matches the one provided in request
2755
+ * User-defined name of aggregation, matches the one specified in request.
2692
2756
  * @maxLength 100
2693
2757
  */
2694
2758
  name?: string;
2695
- /** Type of aggregation that matches result */
2759
+ /** Type of aggregation that matches result. */
2696
2760
  type?: AggregationTypeWithLiterals;
2697
2761
  /**
2698
- * Field to aggregate by, matches the one provided in request
2762
+ * Path to the field to aggregate by in dot notation. For example `appNamespace`.
2699
2763
  * @maxLength 200
2700
2764
  */
2701
2765
  fieldPath?: string;
2702
2766
  }
2703
2767
  /** @oneof */
2704
2768
  interface NestedAggregationResultsResultOneOf {
2705
- /** Value aggregation results */
2769
+ /** Value aggregation results. */
2706
2770
  values?: ValueResults;
2707
- /** Range aggregation results */
2771
+ /** Range aggregation results. */
2708
2772
  ranges?: RangeResults;
2709
- /** Scalar aggregation results */
2773
+ /** Scalar aggregation results. */
2710
2774
  scalar?: AggregationResultsScalarResult;
2711
2775
  }
2712
2776
  interface ValueResults {
2713
2777
  /**
2714
- * List of value aggregations
2778
+ * Array of value aggregation results, each containing a field value and the count of entities with that value.
2715
2779
  * @maxSize 250
2716
2780
  */
2717
2781
  results?: ValueAggregationResult[];
2718
2782
  }
2719
2783
  interface RangeResults {
2720
2784
  /**
2721
- * 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.
2722
2786
  * @maxSize 50
2723
2787
  */
2724
2788
  results?: RangeAggregationResult[];
2725
2789
  }
2726
2790
  interface AggregationResultsScalarResult {
2727
- /** Type of scalar aggregation */
2791
+ /** Type of scalar aggregation. */
2728
2792
  type?: ScalarTypeWithLiterals;
2729
- /** Value of the scalar aggregation */
2793
+ /** Value of the scalar aggregation. */
2730
2794
  value?: number;
2731
2795
  }
2732
2796
  interface NestedValueAggregationResult {
2733
2797
  /**
2734
- * Value of the field
2798
+ * Value of the field.
2735
2799
  * @maxLength 1000
2736
2800
  */
2737
2801
  value?: string;
2738
- /** Nested aggregations */
2802
+ /** Nested aggregations. */
2739
2803
  nestedResults?: NestedAggregationResults;
2740
2804
  }
2741
2805
  interface ValueResult {
2742
2806
  /**
2743
- * Value of the field
2807
+ * Value of the field.
2744
2808
  * @maxLength 1000
2745
2809
  */
2746
2810
  value?: string;
2747
- /** Count of entities with this value */
2811
+ /** Count of entities with this value. */
2748
2812
  count?: number | null;
2749
2813
  }
2750
2814
  interface RangeResult {
2751
- /** Inclusive lower bound of the range */
2815
+ /** Inclusive lower bound of the range. */
2752
2816
  from?: number | null;
2753
- /** Exclusive upper bound of the range */
2817
+ /** Exclusive upper bound of the range. */
2754
2818
  to?: number | null;
2755
- /** Count of entities in this range */
2819
+ /** Count of entities in this range. */
2756
2820
  count?: number | null;
2757
2821
  }
2758
2822
  interface ScalarResult {
2759
- /** Value of the scalar aggregation */
2823
+ /** Value of the scalar aggregation. */
2760
2824
  value?: number;
2761
2825
  }
2762
2826
  interface NestedResultValue extends NestedResultValueResultOneOf {
2763
- /** Value aggregation result */
2827
+ /** Value aggregation result. */
2764
2828
  value?: ValueResult;
2765
- /** Range aggregation result */
2829
+ /** Range aggregation result. */
2766
2830
  range?: RangeResult;
2767
- /** Scalar aggregation result */
2831
+ /** Scalar aggregation result. */
2768
2832
  scalar?: ScalarResult;
2769
- /** Date histogram aggregation result */
2833
+ /** Date histogram aggregation result. */
2770
2834
  dateHistogram?: ValueResult;
2771
2835
  }
2772
2836
  /** @oneof */
2773
2837
  interface NestedResultValueResultOneOf {
2774
- /** Value aggregation result */
2838
+ /** Value aggregation result. */
2775
2839
  value?: ValueResult;
2776
- /** Range aggregation result */
2840
+ /** Range aggregation result. */
2777
2841
  range?: RangeResult;
2778
- /** Scalar aggregation result */
2842
+ /** Scalar aggregation result. */
2779
2843
  scalar?: ScalarResult;
2780
- /** Date histogram aggregation result */
2844
+ /** Date histogram aggregation result. */
2781
2845
  dateHistogram?: ValueResult;
2782
2846
  }
2783
2847
  interface Results {
2784
- /** List of nested aggregations */
2848
+ /** Map of nested aggregation results, keyed by aggregation name. */
2785
2849
  results?: Record<string, NestedResultValue>;
2786
2850
  }
2787
2851
  interface DateHistogramResult {
2788
2852
  /**
2789
- * Date in ISO 8601 format
2853
+ * Date in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
2790
2854
  * @maxLength 100
2791
2855
  */
2792
2856
  value?: string;
2793
- /** Count of documents in the bucket */
2857
+ /** Count of documents in the bucket. */
2794
2858
  count?: number;
2795
2859
  }
2796
2860
  interface GroupByValueResults {
2797
2861
  /**
2798
- * List of value aggregations
2862
+ * Array of nested value aggregation results, each containing a field value and the associated nested aggregation data.
2799
2863
  * @maxSize 1000
2800
2864
  */
2801
2865
  results?: NestedValueAggregationResult[];
2802
2866
  }
2803
2867
  interface DateHistogramResults {
2804
2868
  /**
2805
- * List of date histogram aggregations
2869
+ * Array of date histogram aggregation results, each containing a date bucket and its count.
2806
2870
  * @maxSize 200
2807
2871
  */
2808
2872
  results?: DateHistogramResult[];
2809
2873
  }
2810
2874
  /**
2811
- * Results of `NESTED` aggregation type in a flattened form
2812
- * 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`.
2813
2877
  */
2814
2878
  interface NestedResults {
2815
2879
  /**
2816
- * List of nested aggregations
2880
+ * Array of nested aggregation result groups, each containing multiple aggregation results.
2817
2881
  * @maxSize 1000
2818
2882
  */
2819
2883
  results?: Results[];
2820
2884
  }
2821
2885
  interface AggregationResults extends AggregationResultsResultOneOf {
2822
- /** Value aggregation results */
2886
+ /** Value aggregation results. */
2823
2887
  values?: ValueResults;
2824
- /** Range aggregation results */
2888
+ /** Range aggregation results. */
2825
2889
  ranges?: RangeResults;
2826
- /** Scalar aggregation results */
2890
+ /** Scalar aggregation results. */
2827
2891
  scalar?: AggregationResultsScalarResult;
2828
- /** Group by value aggregation results */
2892
+ /** Group by value aggregation results. */
2829
2893
  groupedByValue?: GroupByValueResults;
2830
- /** Date histogram aggregation results */
2894
+ /** Date histogram aggregation results. */
2831
2895
  dateHistogram?: DateHistogramResults;
2832
- /** Nested aggregation results */
2896
+ /** Nested aggregation results. */
2833
2897
  nested?: NestedResults;
2834
2898
  /**
2835
- * User-defined name of aggregation as derived from search request
2899
+ * User-defined name of aggregation as derived from search request.
2836
2900
  * @maxLength 100
2837
2901
  */
2838
2902
  name?: string;
2839
- /** 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. */
2840
2904
  type?: AggregationTypeWithLiterals;
2841
2905
  /**
2842
- * Field to aggregate by as derived from search request
2906
+ * Path to the field to aggregate by in dot notation. For example `appNamespace`.
2843
2907
  * @maxLength 200
2844
2908
  */
2845
2909
  fieldPath?: string;
2846
2910
  }
2847
2911
  /** @oneof */
2848
2912
  interface AggregationResultsResultOneOf {
2849
- /** Value aggregation results */
2913
+ /** Value aggregation results. */
2850
2914
  values?: ValueResults;
2851
- /** Range aggregation results */
2915
+ /** Range aggregation results. */
2852
2916
  ranges?: RangeResults;
2853
- /** Scalar aggregation results */
2917
+ /** Scalar aggregation results. */
2854
2918
  scalar?: AggregationResultsScalarResult;
2855
- /** Group by value aggregation results */
2919
+ /** Group by value aggregation results. */
2856
2920
  groupedByValue?: GroupByValueResults;
2857
- /** Date histogram aggregation results */
2921
+ /** Date histogram aggregation results. */
2858
2922
  dateHistogram?: DateHistogramResults;
2859
- /** Nested aggregation results */
2923
+ /** Nested aggregation results. */
2860
2924
  nested?: NestedResults;
2861
2925
  }
2862
2926
  interface DeprecatedSearchCategoriesWithOffsetRequest {
@@ -3801,7 +3865,6 @@ interface CategoryMovedEnvelope {
3801
3865
  * @webhook
3802
3866
  * @eventType wix.categories.v1.category_category_moved
3803
3867
  * @slug category_moved
3804
- * @documentationMaturity preview
3805
3868
  */
3806
3869
  declare function onCategoryMoved(handler: (event: CategoryMovedEnvelope) => void | Promise<void>): void;
3807
3870
  interface CategoryCreatedEnvelope {
@@ -3832,7 +3895,6 @@ interface CategoryCreatedEnvelope {
3832
3895
  * @webhook
3833
3896
  * @eventType wix.categories.v1.category_created
3834
3897
  * @slug created
3835
- * @documentationMaturity preview
3836
3898
  */
3837
3899
  declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
3838
3900
  interface CategoryDeletedEnvelope {
@@ -3862,7 +3924,6 @@ interface CategoryDeletedEnvelope {
3862
3924
  * @webhook
3863
3925
  * @eventType wix.categories.v1.category_deleted
3864
3926
  * @slug deleted
3865
- * @documentationMaturity preview
3866
3927
  */
3867
3928
  declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
3868
3929
  interface CategoryItemAddedToCategoryEnvelope {
@@ -3895,7 +3956,6 @@ interface CategoryItemAddedToCategoryEnvelope {
3895
3956
  * @webhook
3896
3957
  * @eventType wix.categories.v1.category_item_added_to_category
3897
3958
  * @slug item_added_to_category
3898
- * @documentationMaturity preview
3899
3959
  */
3900
3960
  declare function onCategoryItemAddedToCategory(handler: (event: CategoryItemAddedToCategoryEnvelope) => void | Promise<void>): void;
3901
3961
  interface CategoryItemRemovedFromCategoryEnvelope {
@@ -3928,7 +3988,6 @@ interface CategoryItemRemovedFromCategoryEnvelope {
3928
3988
  * @webhook
3929
3989
  * @eventType wix.categories.v1.category_item_removed_from_category
3930
3990
  * @slug item_removed_from_category
3931
- * @documentationMaturity preview
3932
3991
  */
3933
3992
  declare function onCategoryItemRemovedFromCategory(handler: (event: CategoryItemRemovedFromCategoryEnvelope) => void | Promise<void>): void;
3934
3993
  interface CategoryItemsArrangedInCategoryEnvelope {
@@ -3961,7 +4020,6 @@ interface CategoryItemsArrangedInCategoryEnvelope {
3961
4020
  * @webhook
3962
4021
  * @eventType wix.categories.v1.category_items_arranged_in_category
3963
4022
  * @slug items_arranged_in_category
3964
- * @documentationMaturity preview
3965
4023
  */
3966
4024
  declare function onCategoryItemsArrangedInCategory(handler: (event: CategoryItemsArrangedInCategoryEnvelope) => void | Promise<void>): void;
3967
4025
  interface CategoryUpdatedEnvelope {
@@ -3992,15 +4050,12 @@ interface CategoryUpdatedEnvelope {
3992
4050
  * @webhook
3993
4051
  * @eventType wix.categories.v1.category_updated
3994
4052
  * @slug updated
3995
- * @documentationMaturity preview
3996
4053
  */
3997
4054
  declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) => void | Promise<void>): void;
3998
- type CategoryNonNullablePaths = `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug`;
3999
4055
  /**
4000
4056
  * Creates a category.
4001
4057
  * @param category - Category to create.
4002
4058
  * @public
4003
- * @documentationMaturity preview
4004
4059
  * @requiredField category
4005
4060
  * @requiredField category.name
4006
4061
  * @requiredField category.parentCategory._id
@@ -4011,7 +4066,7 @@ type CategoryNonNullablePaths = `itemCounter` | `breadcrumbsInfo.breadcrumbs` |
4011
4066
  * @returns Created category.
4012
4067
  * @fqn com.wix.categories.api.v1.CategoriesService.CreateCategory
4013
4068
  */
4014
- declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<Category, CategoryNonNullablePaths> & {
4069
+ 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> & {
4015
4070
  __applicationErrorsType?: CreateCategoryApplicationErrors;
4016
4071
  }>;
4017
4072
  interface CreateCategoryOptions {
@@ -4028,7 +4083,6 @@ interface CreateCategoryOptions {
4028
4083
  * @param categoryId - Category ID.
4029
4084
  * @param treeReference - Category tree reference details.
4030
4085
  * @public
4031
- * @documentationMaturity preview
4032
4086
  * @requiredField categoryId
4033
4087
  * @requiredField treeReference
4034
4088
  * @requiredField treeReference.appNamespace
@@ -4038,7 +4092,7 @@ interface CreateCategoryOptions {
4038
4092
  * @returns Category.
4039
4093
  * @fqn com.wix.categories.api.v1.CategoriesService.GetCategory
4040
4094
  */
4041
- declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
4095
+ 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>>;
4042
4096
  interface GetCategoryOptions {
4043
4097
  /**
4044
4098
  * Fields to include in the response.
@@ -4054,7 +4108,6 @@ interface GetCategoryOptions {
4054
4108
  * This ensures you're working with the latest category and prevents unintended overwrites.
4055
4109
  * @param _id - Category ID.
4056
4110
  * @public
4057
- * @documentationMaturity preview
4058
4111
  * @requiredField _id
4059
4112
  * @requiredField category
4060
4113
  * @requiredField category.revision
@@ -4065,7 +4118,7 @@ interface GetCategoryOptions {
4065
4118
  * @returns Updated category.
4066
4119
  * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategory
4067
4120
  */
4068
- declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<Category, CategoryNonNullablePaths> & {
4121
+ 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> & {
4069
4122
  __applicationErrorsType?: UpdateCategoryApplicationErrors;
4070
4123
  }>;
4071
4124
  interface UpdateCategory {
@@ -4146,6 +4199,8 @@ interface UpdateCategory {
4146
4199
  * @format URL_SLUG
4147
4200
  */
4148
4201
  slug?: string | null;
4202
+ /** Custom SEO data for the category. */
4203
+ seoData?: SeoSchema;
4149
4204
  /**
4150
4205
  * Category description using rich content.
4151
4206
  * > **Note:** Returned only when you pass `"RICH_CONTENT_DESCRIPTION"` to the `fields` array in Categories API requests.
@@ -4184,7 +4239,6 @@ interface UpdateCategoryOptions {
4184
4239
  * @param categoryId - Category ID.
4185
4240
  * @param treeReference - Category tree reference details.
4186
4241
  * @public
4187
- * @documentationMaturity preview
4188
4242
  * @requiredField categoryId
4189
4243
  * @requiredField treeReference
4190
4244
  * @requiredField treeReference.appNamespace
@@ -4192,7 +4246,7 @@ interface UpdateCategoryOptions {
4192
4246
  * @applicableIdentity APP
4193
4247
  * @fqn com.wix.categories.api.v1.CategoriesService.DeleteCategory
4194
4248
  */
4195
- declare function deleteCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>): Promise<void & {
4249
+ declare function deleteCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>): Promise<void & {
4196
4250
  __applicationErrorsType?: DeleteCategoryApplicationErrors;
4197
4251
  }>;
4198
4252
  /**
@@ -4206,7 +4260,6 @@ declare function deleteCategory(categoryId: string, treeReference: NonNullablePa
4206
4260
  * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
4207
4261
  * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
4208
4262
  * @public
4209
- * @documentationMaturity preview
4210
4263
  * @permissionId CATEGORIES.CATEGORY_READ
4211
4264
  * @applicableIdentity APP
4212
4265
  * @applicableIdentity VISITOR
@@ -4244,65 +4297,46 @@ interface CategoriesQueryResult extends QueryCursorResult {
4244
4297
  interface CategoriesQueryBuilder {
4245
4298
  /** @param propertyName - Property whose value is compared with `value`.
4246
4299
  * @param value - Value to compare against.
4247
- * @documentationMaturity preview
4248
4300
  */
4249
4301
  eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
4250
4302
  /** @param propertyName - Property whose value is compared with `value`.
4251
4303
  * @param value - Value to compare against.
4252
- * @documentationMaturity preview
4253
4304
  */
4254
4305
  ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
4255
4306
  /** @param propertyName - Property whose value is compared with `value`.
4256
4307
  * @param value - Value to compare against.
4257
- * @documentationMaturity preview
4258
4308
  */
4259
4309
  ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
4260
4310
  /** @param propertyName - Property whose value is compared with `value`.
4261
4311
  * @param value - Value to compare against.
4262
- * @documentationMaturity preview
4263
4312
  */
4264
4313
  gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
4265
4314
  /** @param propertyName - Property whose value is compared with `value`.
4266
4315
  * @param value - Value to compare against.
4267
- * @documentationMaturity preview
4268
4316
  */
4269
4317
  le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
4270
4318
  /** @param propertyName - Property whose value is compared with `value`.
4271
4319
  * @param value - Value to compare against.
4272
- * @documentationMaturity preview
4273
4320
  */
4274
4321
  lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
4275
4322
  /** @param propertyName - Property whose value is compared with `string`.
4276
4323
  * @param string - String to compare against. Case-insensitive.
4277
- * @documentationMaturity preview
4278
4324
  */
4279
4325
  startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: string) => CategoriesQueryBuilder;
4280
4326
  /** @param propertyName - Property whose value is compared with `values`.
4281
4327
  * @param values - List of values to compare against.
4282
- * @documentationMaturity preview
4283
4328
  */
4284
4329
  hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
4285
- /** @documentationMaturity preview */
4286
4330
  in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
4287
- /** @documentationMaturity preview */
4288
4331
  exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
4289
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
4290
- * @documentationMaturity preview
4291
- */
4332
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
4292
4333
  ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
4293
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
4294
- * @documentationMaturity preview
4295
- */
4334
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
4296
4335
  descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
4297
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
4298
- * @documentationMaturity preview
4299
- */
4336
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
4300
4337
  limit: (limit: number) => CategoriesQueryBuilder;
4301
- /** @param cursor - A pointer to specific record
4302
- * @documentationMaturity preview
4303
- */
4338
+ /** @param cursor - A pointer to specific record */
4304
4339
  skipTo: (cursor: string) => CategoriesQueryBuilder;
4305
- /** @documentationMaturity preview */
4306
4340
  find: () => Promise<CategoriesQueryResult>;
4307
4341
  }
4308
4342
  interface SearchCategoriesOptions {
@@ -4312,13 +4346,13 @@ interface SearchCategoriesOptions {
4312
4346
  */
4313
4347
  treeReference: TreeReference;
4314
4348
  /**
4315
- * Whether to return the categories with `visible: false`.
4349
+ * Whether to return the categories with `visible` set to `false`.
4316
4350
  *
4317
- * Default: `false` - only visible categories are returned in the response
4351
+ * Default: `false`. Only visible categories are returned in the response
4318
4352
  */
4319
4353
  returnNonVisibleCategories?: boolean;
4320
4354
  /**
4321
- * Fields to include in the response.
4355
+ * Array of projected fields. A list of specific field names to return.
4322
4356
  * @maxSize 100
4323
4357
  */
4324
4358
  fields?: RequestedFieldsWithLiterals[];
@@ -4368,8 +4402,8 @@ interface CategorySearchSpec extends SearchSpec {
4368
4402
  type CommonSearchWithEntityContext = Search<Category, CategorySearchSpec>;
4369
4403
  type CategorySearch = {
4370
4404
  /**
4371
- Cursor pointing to page of results.
4372
- When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
4405
+ Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
4406
+ `filter`, `sort`, or `search` can't be specified.
4373
4407
  */
4374
4408
  cursorPaging?: {
4375
4409
  /**
@@ -4387,11 +4421,17 @@ type CategorySearch = {
4387
4421
  cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
4388
4422
  };
4389
4423
  /**
4390
- A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
4424
+ Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
4425
+
4426
+ 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)
4427
+ or the [supported filters article](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting) (REST).
4391
4428
  */
4392
4429
  filter?: CommonSearchWithEntityContext['filter'] | null;
4393
4430
  /**
4394
- Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4431
+ Array of sort objects specifying result order. For example, to sort by creation date in ascending order: `"sort": [{"fieldName": "createdDate", "order": "ASC"}]`.
4432
+
4433
+ 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)
4434
+ or the [supported filters article](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting) (REST).
4395
4435
  @maxSize: 10
4396
4436
  */
4397
4437
  sort?: {
@@ -4406,51 +4446,52 @@ type CategorySearch = {
4406
4446
  order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
4407
4447
  }[];
4408
4448
  /**
4409
- 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.
4449
+ Aggregations for grouping data into categories (facets) and providing summaries for each category.
4450
+ For example, use aggregations to categorize search results by service type, payment options, or locations.
4410
4451
  @maxSize: 10
4411
4452
  */
4412
4453
  aggregations?: {
4413
4454
  /**
4414
- Value aggregation
4455
+ Value aggregation configuration.
4415
4456
  */
4416
4457
  value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
4417
4458
  /**
4418
- Range aggregation
4459
+ Range aggregation configuration.
4419
4460
  */
4420
4461
  range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
4421
4462
  /**
4422
- Scalar aggregation
4463
+ Scalar aggregation configuration.
4423
4464
  */
4424
4465
  scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
4425
4466
  /**
4426
- Date histogram aggregation
4467
+ Date histogram aggregation configuration.
4427
4468
  */
4428
4469
  dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
4429
4470
  /**
4430
- Nested aggregation
4471
+ Nested aggregation configuration.
4431
4472
  */
4432
4473
  nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
4433
4474
  /**
4434
- User-defined name of aggregation, should be unique, will appear in aggregation results
4475
+ User-defined name of aggregation. Must be unique and will appear in aggregation results.
4435
4476
  @maxLength: 100
4436
4477
  */
4437
4478
  name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
4438
4479
  /**
4439
- Type of aggregation, client must provide matching aggregation field below
4480
+ Type of aggregation. Client must specify matching aggregation field below.
4440
4481
  */
4441
4482
  type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
4442
4483
  /**
4443
- Field to aggregate by, use dot notation to specify json path
4484
+ Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
4444
4485
  @maxLength: 200
4445
4486
  */
4446
4487
  fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
4447
4488
  }[];
4448
4489
  /**
4449
- Free text to match in searchable fields
4490
+ Free text to match in searchable fields.
4450
4491
  */
4451
4492
  search?: {
4452
4493
  /**
4453
- Defines how separate search terms in `expression` are combined.
4494
+ Search mode. Defines the search logic for combining multiple terms in the `expression`.
4454
4495
  */
4455
4496
  mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
4456
4497
  /**
@@ -4459,26 +4500,20 @@ type CategorySearch = {
4459
4500
  */
4460
4501
  expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
4461
4502
  /**
4462
- Fields in which to search for the `expression`. Use dot notation to specify field path.
4463
-
4464
- When empty - all searchable fields are looked at.
4503
+ 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`.
4465
4504
  @maxLength: 200,
4466
4505
  @maxSize: 20
4467
4506
  */
4468
4507
  fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
4469
4508
  /**
4470
- Whether to use fuzzy search - allowing typos and other minor errors in the search.
4509
+ 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.
4471
4510
  */
4472
4511
  fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
4473
4512
  };
4474
4513
  /**
4475
- UTC offset or IANA time zone. Valid values are
4476
- ISO 8601 UTC offsets, such as +02:00 or -06:00,
4477
- and IANA time zone IDs, such as Europe/Rome
4514
+ 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`.
4478
4515
 
4479
- Affects all filters and aggregations returned values.
4480
- You may override this behavior in a specific filter by providing
4481
- timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
4516
+ 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)).
4482
4517
  @maxLength: 50
4483
4518
  */
4484
4519
  timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
@@ -4489,7 +4524,6 @@ type CategorySearch = {
4489
4524
  * For field support for filters and sorting,
4490
4525
  * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
4491
4526
  * @public
4492
- * @documentationMaturity preview
4493
4527
  * @requiredField options.treeReference
4494
4528
  * @requiredField options.treeReference.appNamespace
4495
4529
  * @permissionId CATEGORIES.CATEGORY_READ
@@ -4497,7 +4531,7 @@ type CategorySearch = {
4497
4531
  * @applicableIdentity VISITOR
4498
4532
  * @fqn com.wix.categories.api.v1.CategoriesService.CountCategories
4499
4533
  */
4500
- declare function countCategories(options?: NonNullablePaths<CountCategoriesOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<CountCategoriesResponse, `count`>>;
4534
+ declare function countCategories(options?: NonNullablePaths<CountCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<CountCategoriesResponse, `count`, 2>>;
4501
4535
  interface CountCategoriesOptions {
4502
4536
  /**
4503
4537
  * Filter object.
@@ -4521,7 +4555,6 @@ interface CountCategoriesOptions {
4521
4555
  * @param categoryId - ID of the category to move.
4522
4556
  * @param treeReference - Category tree reference details.
4523
4557
  * @public
4524
- * @documentationMaturity preview
4525
4558
  * @requiredField categoryId
4526
4559
  * @requiredField options.position
4527
4560
  * @requiredField treeReference
@@ -4530,7 +4563,7 @@ interface CountCategoriesOptions {
4530
4563
  * @applicableIdentity APP
4531
4564
  * @fqn com.wix.categories.api.v1.CategoriesService.MoveCategory
4532
4565
  */
4533
- declare function moveCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: NonNullablePaths<MoveCategoryOptions, `position`>): Promise<NonNullablePaths<MoveCategoryResponse, `categoriesAfterMove`> & {
4566
+ declare function moveCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: NonNullablePaths<MoveCategoryOptions, `position`, 2>): Promise<NonNullablePaths<MoveCategoryResponse, `categoriesAfterMove`, 2> & {
4534
4567
  __applicationErrorsType?: MoveCategoryApplicationErrors;
4535
4568
  }>;
4536
4569
  interface MoveCategoryOptions {
@@ -4563,7 +4596,6 @@ interface MoveCategoryOptions {
4563
4596
  * This ensures you're working with the latest category and prevents unintended overwrites.
4564
4597
  * @param categories - List of categories to update.
4565
4598
  * @public
4566
- * @documentationMaturity preview
4567
4599
  * @requiredField categories
4568
4600
  * @requiredField categories.category
4569
4601
  * @requiredField categories.category._id
@@ -4574,9 +4606,7 @@ interface MoveCategoryOptions {
4574
4606
  * @applicableIdentity APP
4575
4607
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkUpdateCategories
4576
4608
  */
4577
- 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` | {
4578
- [P in CategoryNonNullablePaths]: `results.${number}.category.${P}`;
4579
- }[CategoryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
4609
+ 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> & {
4580
4610
  __applicationErrorsType?: BulkUpdateCategoriesApplicationErrors;
4581
4611
  }>;
4582
4612
  interface BulkUpdateCategoriesOptions {
@@ -4603,7 +4633,6 @@ interface BulkUpdateCategoriesOptions {
4603
4633
  * This ensures you're working with the latest category and prevents unintended overwrites.
4604
4634
  * @param categoryId - Category ID.
4605
4635
  * @public
4606
- * @documentationMaturity preview
4607
4636
  * @requiredField categoryId
4608
4637
  * @requiredField options.revision
4609
4638
  * @requiredField options.treeReference
@@ -4613,9 +4642,7 @@ interface BulkUpdateCategoriesOptions {
4613
4642
  * @applicableIdentity APP
4614
4643
  * @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategoryVisibility
4615
4644
  */
4616
- declare function updateCategoryVisibility(categoryId: string, options?: NonNullablePaths<UpdateCategoryVisibilityOptions, `revision` | `treeReference` | `treeReference.appNamespace` | `visible`>): Promise<NonNullablePaths<UpdateCategoryVisibilityResponse, {
4617
- [P in CategoryNonNullablePaths]: `category.${P}`;
4618
- }[CategoryNonNullablePaths]> & {
4645
+ 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> & {
4619
4646
  __applicationErrorsType?: UpdateCategoryVisibilityApplicationErrors;
4620
4647
  }>;
4621
4648
  interface UpdateCategoryVisibilityOptions {
@@ -4646,7 +4673,6 @@ interface UpdateCategoryVisibilityOptions {
4646
4673
  * > **Note:** If one of the passed categories has a parent category that is not visible, the passed category will not be updated.
4647
4674
  * @param categoryIds - IDs of the categories to update.
4648
4675
  * @public
4649
- * @documentationMaturity preview
4650
4676
  * @requiredField categoryIds
4651
4677
  * @requiredField options.treeReference
4652
4678
  * @requiredField options.treeReference.appNamespace
@@ -4654,9 +4680,7 @@ interface UpdateCategoryVisibilityOptions {
4654
4680
  * @applicableIdentity APP
4655
4681
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkShowCategories
4656
4682
  */
4657
- 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` | {
4658
- [P in CategoryNonNullablePaths]: `results.${number}.category.${P}`;
4659
- }[CategoryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
4683
+ 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>>;
4660
4684
  interface BulkShowCategoriesOptions {
4661
4685
  /** Category tree reference details. */
4662
4686
  treeReference: TreeReference;
@@ -4677,7 +4701,6 @@ interface BulkShowCategoriesOptions {
4677
4701
  * @param categoryId - Category ID.
4678
4702
  * @param items - List of items to add.
4679
4703
  * @public
4680
- * @documentationMaturity preview
4681
4704
  * @requiredField categoryId
4682
4705
  * @requiredField items
4683
4706
  * @requiredField items.appId
@@ -4689,7 +4712,7 @@ interface BulkShowCategoriesOptions {
4689
4712
  * @applicableIdentity APP
4690
4713
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkAddItemsToCategory
4691
4714
  */
4692
- 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`> & {
4715
+ 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> & {
4693
4716
  __applicationErrorsType?: BulkAddItemsToCategoryApplicationErrors;
4694
4717
  }>;
4695
4718
  interface BulkAddItemsToCategoryOptions {
@@ -4700,7 +4723,6 @@ interface BulkAddItemsToCategoryOptions {
4700
4723
  * Adds a single item to multiple categories.
4701
4724
  * @param item - Item to add.
4702
4725
  * @public
4703
- * @documentationMaturity preview
4704
4726
  * @requiredField item
4705
4727
  * @requiredField item.appId
4706
4728
  * @requiredField item.catalogItemId
@@ -4712,7 +4734,7 @@ interface BulkAddItemsToCategoryOptions {
4712
4734
  * @applicableIdentity APP
4713
4735
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkAddItemToCategories
4714
4736
  */
4715
- 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`> & {
4737
+ 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> & {
4716
4738
  __applicationErrorsType?: BulkAddItemToCategoriesApplicationErrors;
4717
4739
  }>;
4718
4740
  interface BulkAddItemToCategoriesOptions {
@@ -4731,7 +4753,6 @@ interface BulkAddItemToCategoriesOptions {
4731
4753
  * @param categoryId - Category ID.
4732
4754
  * @param items - List of items to remove.
4733
4755
  * @public
4734
- * @documentationMaturity preview
4735
4756
  * @requiredField categoryId
4736
4757
  * @requiredField items
4737
4758
  * @requiredField items.appId
@@ -4743,7 +4764,7 @@ interface BulkAddItemToCategoriesOptions {
4743
4764
  * @applicableIdentity APP
4744
4765
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkRemoveItemsFromCategory
4745
4766
  */
4746
- 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`> & {
4767
+ 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> & {
4747
4768
  __applicationErrorsType?: BulkRemoveItemsFromCategoryApplicationErrors;
4748
4769
  }>;
4749
4770
  interface BulkRemoveItemsFromCategoryOptions {
@@ -4754,7 +4775,6 @@ interface BulkRemoveItemsFromCategoryOptions {
4754
4775
  * Removes a single item from multiple categories.
4755
4776
  * @param item - Item to remove.
4756
4777
  * @public
4757
- * @documentationMaturity preview
4758
4778
  * @requiredField item
4759
4779
  * @requiredField item.appId
4760
4780
  * @requiredField item.catalogItemId
@@ -4766,7 +4786,7 @@ interface BulkRemoveItemsFromCategoryOptions {
4766
4786
  * @applicableIdentity APP
4767
4787
  * @fqn com.wix.categories.api.v1.CategoriesService.BulkRemoveItemFromCategories
4768
4788
  */
4769
- 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`> & {
4789
+ 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> & {
4770
4790
  __applicationErrorsType?: BulkRemoveItemFromCategoriesApplicationErrors;
4771
4791
  }>;
4772
4792
  interface BulkRemoveItemFromCategoriesOptions {
@@ -4788,7 +4808,6 @@ interface BulkRemoveItemFromCategoriesOptions {
4788
4808
  * @param categoryId - Category ID.
4789
4809
  * @param treeReference - Category tree reference details.
4790
4810
  * @public
4791
- * @documentationMaturity preview
4792
4811
  * @requiredField categoryId
4793
4812
  * @requiredField treeReference
4794
4813
  * @requiredField treeReference.appNamespace
@@ -4797,7 +4816,7 @@ interface BulkRemoveItemFromCategoriesOptions {
4797
4816
  * @applicableIdentity VISITOR
4798
4817
  * @fqn com.wix.categories.api.v1.CategoriesService.ListItemsInCategory
4799
4818
  */
4800
- declare function listItemsInCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: ListItemsInCategoryOptions): Promise<NonNullablePaths<ListItemsInCategoryResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`>>;
4819
+ declare function listItemsInCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: ListItemsInCategoryOptions): Promise<NonNullablePaths<ListItemsInCategoryResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4>>;
4801
4820
  interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMethodOneOf {
4802
4821
  /**
4803
4822
  * Whether to use category arrangement for sorting items.
@@ -4831,7 +4850,6 @@ interface ListItemsInCategoryOptionsPagingMethodOneOf {
4831
4850
  * Retrieves a list of categories that contain the specified item.
4832
4851
  * @param item - Item reference info.
4833
4852
  * @public
4834
- * @documentationMaturity preview
4835
4853
  * @requiredField item
4836
4854
  * @requiredField options
4837
4855
  * @requiredField options.treeReference
@@ -4841,7 +4859,7 @@ interface ListItemsInCategoryOptionsPagingMethodOneOf {
4841
4859
  * @applicableIdentity VISITOR
4842
4860
  * @fqn com.wix.categories.api.v1.CategoriesService.ListCategoriesForItem
4843
4861
  */
4844
- declare function listCategoriesForItem(item: ItemReference, options: NonNullablePaths<ListCategoriesForItemOptions, `treeReference` | `treeReference.appNamespace`>): Promise<NonNullablePaths<ListCategoriesForItemResponse, `directCategoryIds` | `allCategoryIds`>>;
4862
+ declare function listCategoriesForItem(item: ItemReference, options: NonNullablePaths<ListCategoriesForItemOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<ListCategoriesForItemResponse, `directCategoryIds` | `allCategoryIds`, 2>>;
4845
4863
  interface ListCategoriesForItemOptions {
4846
4864
  /** Category tree reference details. */
4847
4865
  treeReference: TreeReference;
@@ -4850,7 +4868,6 @@ interface ListCategoriesForItemOptions {
4850
4868
  * Retrieves a map where the keys are ItemReferences, and the values are lists of categories that contain the corresponding item.
4851
4869
  * @param items - List of Item reference info.
4852
4870
  * @public
4853
- * @documentationMaturity preview
4854
4871
  * @requiredField items
4855
4872
  * @requiredField items.appId
4856
4873
  * @requiredField items.catalogItemId
@@ -4862,7 +4879,7 @@ interface ListCategoriesForItemOptions {
4862
4879
  * @applicableIdentity VISITOR
4863
4880
  * @fqn com.wix.categories.api.v1.CategoriesService.ListCategoriesForItems
4864
4881
  */
4865
- 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`>>;
4882
+ 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>>;
4866
4883
  interface ListCategoriesForItemsOptions {
4867
4884
  /** Category tree reference details. */
4868
4885
  treeReference: TreeReference;
@@ -4870,13 +4887,12 @@ interface ListCategoriesForItemsOptions {
4870
4887
  /**
4871
4888
  * Retrieves a list of all trees installed on the site, sorted by `appNamespace` in ascending order.
4872
4889
  * @public
4873
- * @documentationMaturity preview
4874
4890
  * @permissionId CATEGORIES.CATEGORY_READ
4875
4891
  * @applicableIdentity APP
4876
4892
  * @applicableIdentity VISITOR
4877
4893
  * @fqn com.wix.categories.api.v1.CategoriesService.ListTrees
4878
4894
  */
4879
- declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees` | `trees.${number}.appNamespace`>>;
4895
+ declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees` | `trees.${number}.appNamespace`, 4>>;
4880
4896
  /**
4881
4897
  * Sets arranged items in a category.
4882
4898
  *
@@ -4885,7 +4901,6 @@ declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees
4885
4901
  * @param categoryId - Category ID.
4886
4902
  * @param treeReference - Category tree reference details.
4887
4903
  * @public
4888
- * @documentationMaturity preview
4889
4904
  * @requiredField categoryId
4890
4905
  * @requiredField treeReference
4891
4906
  * @requiredField treeReference.appNamespace
@@ -4893,7 +4908,7 @@ declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees
4893
4908
  * @applicableIdentity APP
4894
4909
  * @fqn com.wix.categories.api.v1.CategoriesService.SetArrangedItems
4895
4910
  */
4896
- declare function setArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>, options?: SetArrangedItemsOptions): Promise<NonNullablePaths<SetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`> & {
4911
+ declare function setArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: SetArrangedItemsOptions): Promise<NonNullablePaths<SetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4> & {
4897
4912
  __applicationErrorsType?: SetArrangedItemsApplicationErrors;
4898
4913
  }>;
4899
4914
  interface SetArrangedItemsOptions {
@@ -4908,7 +4923,6 @@ interface SetArrangedItemsOptions {
4908
4923
  * @param categoryId - Category ID.
4909
4924
  * @param treeReference - Category tree reference details.
4910
4925
  * @public
4911
- * @documentationMaturity preview
4912
4926
  * @requiredField categoryId
4913
4927
  * @requiredField treeReference
4914
4928
  * @requiredField treeReference.appNamespace
@@ -4917,6 +4931,6 @@ interface SetArrangedItemsOptions {
4917
4931
  * @applicableIdentity VISITOR
4918
4932
  * @fqn com.wix.categories.api.v1.CategoriesService.GetArrangedItems
4919
4933
  */
4920
- declare function getArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`>): Promise<NonNullablePaths<GetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`>>;
4934
+ declare function getArrangedItems(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>): Promise<NonNullablePaths<GetArrangedItemsResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4>>;
4921
4935
 
4922
- 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 ListCompactCategoriesByIdsResponse 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 Page as cA, type URI as cB, type File as cC, type CustomTag as cD, type CategoryMoved as cE, type ItemAddedToCategory as cF, type ItemsAddedToCategory as cG, type ItemRemovedFromCategory as cH, type ItemsRemovedFromCategory as cI, type ItemsArrangedInCategory as cJ, type CreateCategoryRequest as cK, type CreateCategoryResponse as cL, type GetCategoryRequest as cM, type GetCategoryResponse as cN, type UpdateCategoryRequest as cO, type UpdateCategoryResponse as cP, type DeleteCategoryRequest as cQ, type DeleteCategoryResponse as cR, type QueryCategoriesRequest as cS, type CursorQuery as cT, type CursorQueryPagingMethodOneOf as cU, type Sorting as cV, type CursorPaging as cW, type QueryCategoriesResponse as cX, type CursorPagingMetadata as cY, type Cursors as cZ, type ListCompactCategoriesByIdsRequest as c_, type RibbonStyles as ca, type CardStyles as cb, type VideoData as cc, type PlaybackOptions as cd, type EmbedData as ce, type Oembed as cf, type CollapsibleListData as cg, type TableData as ch, type Dimensions as ci, type TableCellData as cj, type CellStyle as ck, type BorderColors as cl, type ListValue as cm, type AudioData as cn, type OrderedListData as co, type BulletedListData as cp, type BlockquoteData as cq, type CaptionData as cr, type LayoutCellData as cs, type Metadata as ct, type DocumentStyle as cu, type TextNodeStyle as cv, type ExtendedFields as cw, type InvalidateCache as cx, type InvalidateCacheGetByOneOf as cy, type App as cz, type UpdateCategoryApplicationErrors as d, type BulkRemoveItemFromCategoriesRequest as d$, type CompactCategory as d0, type SearchCategoriesRequest as d1, type CursorSearch as d2, type CursorSearchPagingMethodOneOf as d3, type Aggregation as d4, type AggregationKindOneOf as d5, type RangeBucket as d6, type IncludeMissingValuesOptions as d7, type ValueAggregation as d8, type ValueAggregationOptionsOneOf as d9, type NestedResults as dA, type AggregationResults as dB, type AggregationResultsResultOneOf as dC, type DeprecatedSearchCategoriesWithOffsetRequest as dD, type OffsetSearch as dE, type OffsetSearchPagingMethodOneOf as dF, type Paging as dG, type DeprecatedSearchCategoriesWithOffsetResponse as dH, type PagingMetadata as dI, type CountCategoriesRequest as dJ, type MoveCategoryRequest as dK, type BulkUpdateCategoriesRequest as dL, type BulkCategoriesResult as dM, type ItemMetadata as dN, type ApplicationError as dO, type BulkActionMetadata as dP, type UpdateCategoryVisibilityRequest as dQ, type BulkShowCategoriesRequest as dR, type BulkDeleteCategoriesRequest as dS, type BulkDeleteCategoriesResponse as dT, type BulkDeleteCategoriesResponseBulkCategoriesResult as dU, type BulkAddItemsToCategoryRequest as dV, type BulkItemsToCategoryResult as dW, type ItemReferenceMetadata as dX, type BulkAddItemToCategoriesRequest as dY, type BulkItemToCategoriesResult as dZ, type BulkRemoveItemsFromCategoryRequest as d_, type RangeAggregation as da, type ScalarAggregation as db, type DateHistogramAggregation as dc, type NestedAggregationItem as dd, type NestedAggregationItemKindOneOf as de, type NestedAggregation as df, type SearchDetails as dg, type AggregationData as dh, type ValueAggregationResult as di, type RangeAggregationResult as dj, type NestedAggregationResults as dk, type NestedAggregationResultsResultOneOf as dl, type ValueResults as dm, type RangeResults as dn, type AggregationResultsScalarResult as dp, type NestedValueAggregationResult as dq, type ValueResult as dr, type RangeResult as ds, type ScalarResult as dt, type NestedResultValue as du, type NestedResultValueResultOneOf as dv, type Results as dw, type DateHistogramResult as dx, type GroupByValueResults as dy, type DateHistogramResults as dz, type CategoriesQueryBuilder as e, type InitialExpandedItemsWithLiterals as e$, type ListItemsInCategoryRequest as e0, type ListItemsInCategoryRequestPagingMethodOneOf as e1, type PagingMetadataV2 as e2, type ListCategoriesForItemRequest as e3, type ListCategoriesForItemsRequest as e4, type MapItemToCategories as e5, type ListTreesRequest as e6, type MoveItemInCategoryRequest as e7, type MoveItemInCategoryResponse as e8, type SetArrangedItemsRequest as e9, type LineStyleWithLiterals as eA, type WidthWithLiterals as eB, type DividerDataAlignmentWithLiterals as eC, type ViewModeWithLiterals as eD, type LayoutTypeWithLiterals as eE, type OrientationWithLiterals as eF, type CropWithLiterals as eG, type ThumbnailsAlignmentWithLiterals as eH, type GIFTypeWithLiterals as eI, type SourceWithLiterals as eJ, type StylesPositionWithLiterals as eK, type MapTypeWithLiterals as eL, type ViewRoleWithLiterals as eM, type VoteRoleWithLiterals as eN, type PollLayoutTypeWithLiterals as eO, type PollLayoutDirectionWithLiterals as eP, type BackgroundTypeWithLiterals as eQ, type DecorationTypeWithLiterals as eR, type FontTypeWithLiterals as eS, type ImageStylesPositionWithLiterals as eT, type AspectRatioWithLiterals as eU, type ResizingWithLiterals as eV, type PlacementWithLiterals as eW, type TypeWithLiterals as eX, type AlignmentWithLiterals as eY, type LayoutWithLiterals as eZ, type AppTypeWithLiterals as e_, type GetArrangedItemsRequest as ea, type GetCategoriesTreeRequest as eb, type GetCategoriesTreeResponse as ec, type CategoryTreeNode as ed, type DomainEvent as ee, type DomainEventBodyOneOf as ef, type EntityCreatedEvent as eg, type RestoreInfo as eh, type EntityUpdatedEvent as ei, type EntityDeletedEvent as ej, type ActionEvent as ek, type Empty as el, type MessageEnvelope as em, type IdentificationData as en, type IdentificationDataIdOneOf as eo, type BaseEventMetadata as ep, type EventMetadata as eq, type CategoriesQueryResult as er, type CategorySearchSpec as es, type ListItemsInCategoryOptionsPagingMethodOneOf as et, type NodeTypeWithLiterals as eu, type WidthTypeWithLiterals as ev, type PluginContainerDataAlignmentWithLiterals as ew, type ButtonDataTypeWithLiterals as ex, type TargetWithLiterals as ey, type TextAlignmentWithLiterals as ez, type CategorySearch as f, type DirectionWithLiterals as f0, type VerticalAlignmentWithLiterals as f1, type NullValueWithLiterals as f2, type SingleEntityOpsRequestedFieldsWithLiterals as f3, type SortOrderWithLiterals as f4, type RequestedFieldsWithLiterals as f5, type SortTypeWithLiterals as f6, type SortDirectionWithLiterals as f7, type MissingValuesWithLiterals as f8, type ScalarTypeWithLiterals as f9, bulkAddItemToCategories as fA, bulkRemoveItemsFromCategory as fB, bulkRemoveItemFromCategories as fC, listItemsInCategory as fD, listCategoriesForItem as fE, listCategoriesForItems as fF, listTrees as fG, setArrangedItems as fH, getArrangedItems as fI, type NestedAggregationTypeWithLiterals as fa, type IntervalWithLiterals as fb, type AggregationTypeWithLiterals as fc, type ModeWithLiterals as fd, type PositionWithLiterals as fe, type MoveItemInCategoryRequestPositionWithLiterals as ff, type WebhookIdentityTypeWithLiterals as fg, onCategoryMoved as fh, onCategoryCreated as fi, onCategoryDeleted as fj, onCategoryItemAddedToCategory as fk, onCategoryItemRemovedFromCategory as fl, onCategoryItemsArrangedInCategory as fm, onCategoryUpdated as fn, createCategory as fo, getCategory as fp, updateCategory as fq, deleteCategory as fr, queryCategories as fs, type CommonSearchWithEntityContext as ft, countCategories as fu, moveCategory as fv, bulkUpdateCategories as fw, updateCategoryVisibility as fx, bulkShowCategories as fy, bulkAddItemsToCategory 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 };
4936
+ 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, type CommonSearchWithEntityContext as fi, onCategoryMoved as fj, onCategoryCreated as fk, onCategoryDeleted as fl, onCategoryItemAddedToCategory as fm, onCategoryItemRemovedFromCategory as fn, onCategoryItemsArrangedInCategory as fo, onCategoryUpdated as fp, createCategory as fq, getCategory as fr, updateCategory as fs, deleteCategory as ft, queryCategories 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 };