@wix/auto_sdk_categories_categories 1.0.1 → 1.0.2

package/build/cjs/src/categories-v1-category-categories.types.d.ts

@@ -1,5 +1,9 @@
 export interface Category {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     * @immutable
+     */
     id?: string | null;
     /**
      * Revision number, which increments by 1 each time the category is updated.
@@ -19,7 +23,11 @@ export interface Category {
      * @readonly
      */
     updatedDate?: Date | null;
-    /** Category name. */
+    /**
+     * Category name.
+     * @minLength 1
+     * @maxLength 80
+     */
     name?: string | null;
     /**
      * Category image.
@@ -36,6 +44,8 @@ export interface Category {
     /**
      * Category description.
      * > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
+     * @minLength 1
+     * @maxLength 600
      */
     description?: string | null;
     /**
@@ -44,6 +54,7 @@ export interface Category {
      * + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
      * + Passing `true` will fail if the visibility of any parent categories is `false`.
      * + Default: `false`.
+     * @immutable
      */
     visible?: boolean | null;
     /**
@@ -53,12 +64,16 @@ export interface Category {
      * @readonly
      */
     breadcrumbsInfo?: BreadcrumbsInfo;
-    /** Parent category reference data. */
+    /**
+     * Parent category reference data.
+     * @immutable
+     */
     parentCategory?: ParentCategory;
     /**
      * Category slug.
      *
      * If not provided, the slug is autogenerated based on the category name.
+     * @format URL_SLUG
      */
     slug?: string | null;
     /**
@@ -74,6 +89,8 @@ export interface Category {
      * ID of the app responsible for managing the items in this category.
      *
      * Pass your app ID to restrict updating and deleting items in this category to your app only.
+     * @format GUID
+     * @immutable
      */
     managingAppId?: string | null;
     /**
@@ -84,9 +101,15 @@ export interface Category {
     extendedFields?: ExtendedFields;
 }
 export interface Image {
-    /** WixMedia image ID. */
+    /**
+     * WixMedia image ID.
+     * @maxLength 400
+     */
     id?: string;
-    /** Image URL. */
+    /**
+     * Image URL.
+     * @format WEB_URL
+     */
     url?: string;
     /**
      * Original image height.
@@ -98,11 +121,15 @@ export interface Image {
      * @readonly
      */
     width?: number;
-    /** Image alt text. */
+    /**
+     * Image alt text.
+     * @maxLength 200
+     */
     altText?: string | null;
     /**
      * Image filename.
      * @readonly
+     * @maxLength 200
      */
     filename?: string | null;
 }
@@ -110,15 +137,27 @@ export interface BreadcrumbsInfo {
     /**
      * List of breadcrumb data. The current category isn't included in the list.
      * @readonly
+     * @maxSize 5
      */
     breadcrumbs?: Breadcrumb[];
 }
 export interface Breadcrumb {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
-    /** Category name. */
+    /**
+     * Category name.
+     * @minLength 1
+     * @maxLength 80
+     */
     categoryName?: string;
-    /** Category slug. */
+    /**
+     * Category slug.
+     * @minLength 1
+     * @maxLength 100
+     */
     categorySlug?: string;
 }
 export interface ParentCategory {
@@ -126,6 +165,7 @@ export interface ParentCategory {
      * Parent category ID.
      *
      * Default: root category ID
+     * @format GUID
      */
     id?: string | null;
     /**
@@ -150,7 +190,10 @@ export interface Keyword {
     term?: string;
     /** Whether the keyword is the main focus keyword. */
     isMain?: boolean;
-    /** The source that added the keyword terms to the SEO settings. */
+    /**
+     * The source that added the keyword terms to the SEO settings.
+     * @maxLength 1000
+     */
     origin?: string | null;
 }
 export interface Tag {
@@ -183,7 +226,10 @@ export interface Settings {
      * Default: `false` (Auto Redirect is enabled.)
      */
     preventAutoRedirect?: boolean;
-    /** User-selected keyword terms for a specific page. */
+    /**
+     * User-selected keyword terms for a specific page.
+     * @maxSize 5
+     */
     keywords?: Keyword[];
 }
 export interface RichContent {
@@ -784,11 +830,20 @@ export interface GIFData {
     gifType?: GIFType;
 }
 export interface GIF {
-    /** GIF format URL. */
+    /**
+     * GIF format URL.
+     * @format WEB_URL
+     */
     gif?: string | null;
-    /** MP4 format URL. */
+    /**
+     * MP4 format URL.
+     * @format WEB_URL
+     */
     mp4?: string | null;
-    /** Thumbnail URL. */
+    /**
+     * Thumbnail URL.
+     * @format WEB_URL
+     */
     still?: string | null;
 }
 export declare enum GIFType {
@@ -1016,13 +1071,22 @@ export declare enum BackgroundType {
 export interface Gradient {
     /** The gradient angle in degrees. */
     angle?: number | null;
-    /** The start color as a hexademical value. */
+    /**
+     * The start color as a hexademical value.
+     * @format COLOR_HEX
+     */
     startColor?: string | null;
-    /** The end color as a hexademical value. */
+    /**
+     * The end color as a hexademical value.
+     * @format COLOR_HEX
+     */
     lastColor?: string | null;
 }
 export interface Background extends BackgroundBackgroundOneOf {
-    /** The background color as a hexademical value. */
+    /**
+     * The background color as a hexademical value.
+     * @format COLOR_HEX
+     */
     color?: string | null;
     /** An image to use for the background. */
     image?: Media;
@@ -1033,7 +1097,10 @@ export interface Background extends BackgroundBackgroundOneOf {
 }
 /** @oneof */
 export interface BackgroundBackgroundOneOf {
-    /** The background color as a hexademical value. */
+    /**
+     * The background color as a hexademical value.
+     * @format COLOR_HEX
+     */
     color?: string | null;
     /** An image to use for the background. */
     image?: Media;
@@ -1345,17 +1412,32 @@ export declare enum VerticalAlignment {
 export interface CellStyle {
     /** Vertical alignment for the cell's text. */
     verticalAlignment?: VerticalAlignment;
-    /** Cell background color as a hexadecimal value. */
+    /**
+     * Cell background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     backgroundColor?: string | null;
 }
 export interface BorderColors {
-    /** Left border color as a hexadecimal value. */
+    /**
+     * Left border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     left?: string | null;
-    /** Right border color as a hexadecimal value. */
+    /**
+     * Right border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     right?: string | null;
-    /** Top border color as a hexadecimal value. */
+    /**
+     * Top border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     top?: string | null;
-    /** Bottom border color as a hexadecimal value. */
+    /**
+     * Bottom border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     bottom?: string | null;
 }
 /**
@@ -1468,9 +1550,15 @@ export interface TreeReference {
      * Namespace of the app that manages the tree.
      *
      * For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
+     * @minLength 4
+     * @maxLength 150
      */
     appNamespace?: string;
-    /** Tree key. You must pass this when a single app manages more than one tree. */
+    /**
+     * Tree key. You must pass this when a single app manages more than one tree.
+     * @minLength 1
+     * @maxLength 44
+     */
     treeKey?: string | null;
 }
 export interface ExtendedFields {
@@ -1485,9 +1573,15 @@ export interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -1497,7 +1591,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     uri?: URI;
     /** Invalidate by file (for media files such as PDFs) */
     file?: File;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    /**
+     * tell us why you're invalidating the cache. You don't need to add your app name
+     * @maxLength 256
+     */
     reason?: string | null;
     /** Is local DS */
     localDc?: boolean;
@@ -1505,9 +1602,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
 }
 /** @oneof */
 export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -1519,31 +1622,59 @@ export interface InvalidateCacheGetByOneOf {
     file?: File;
 }
 export interface App {
-    /** The AppDefId */
+    /**
+     * The AppDefId
+     * @minLength 1
+     */
     appDefId?: string;
-    /** The instance Id */
+    /**
+     * The instance Id
+     * @format GUID
+     */
     instanceId?: string;
 }
 export interface Page {
-    /** the msid the page is on */
+    /**
+     * the msid the page is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Page ID */
+    /**
+     * Invalidate by Page ID
+     * @minLength 1
+     */
     pageId?: string;
 }
 export interface URI {
-    /** the msid the URI is on */
+    /**
+     * the msid the URI is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    /**
+     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @minLength 1
+     */
     uriPath?: string;
 }
 export interface File {
-    /** the msid the file is related to */
+    /**
+     * the msid the file is related to
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by filename (for media files such as PDFs) */
+    /**
+     * Invalidate by filename (for media files such as PDFs)
+     * @minLength 1
+     * @maxLength 256
+     */
     fileName?: string;
 }
 export interface CategoryMoved {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
     /** Parent category details. */
     parentCategory?: ParentCategory;
@@ -1551,7 +1682,10 @@ export interface CategoryMoved {
     treeReference?: TreeReference;
 }
 export interface ItemAddedToCategory {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
     /** Details about the added item. */
     addedItem?: ItemReference;
@@ -1563,6 +1697,8 @@ export interface ItemReference {
      * ID of the item within the catalog it belongs to.
      *
      * For example, `product.id` for Wix Stores or `event.id` for Wix Events.
+     * @minLength 1
+     * @maxLength 36
      */
     catalogItemId?: string;
     /**
@@ -1574,19 +1710,30 @@ export interface ItemReference {
      * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
      * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
      * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     * @minLength 1
+     * @maxLength 36
      */
     appId?: string;
 }
 export interface ItemsAddedToCategory {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
-    /** List of added items. */
+    /**
+     * List of added items.
+     * @maxSize 100
+     */
     addedItems?: ItemReference[];
     /** Category tree reference details. */
     treeReference?: TreeReference;
 }
 export interface ItemRemovedFromCategory {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
     /** Details about the removed item. */
     removedItem?: ItemReference;
@@ -1594,15 +1741,24 @@ export interface ItemRemovedFromCategory {
     treeReference?: TreeReference;
 }
 export interface ItemsRemovedFromCategory {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
-    /** List of removed items. */
+    /**
+     * List of removed items.
+     * @maxSize 100
+     */
     removedItems?: ItemReference[];
     /** Category tree reference details. */
     treeReference?: TreeReference;
 }
 export interface ItemsArrangedInCategory {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
     /** Category tree reference details. */
     treeReference?: TreeReference;
@@ -1612,7 +1768,10 @@ export interface CreateCategoryRequest {
     category: Category;
     /** Category tree reference details. */
     treeReference: TreeReference;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: SingleEntityOpsRequestedFields[];
 }
 export declare enum SingleEntityOpsRequestedFields {
@@ -1627,11 +1786,17 @@ export interface CreateCategoryResponse {
     category?: Category;
 }
 export interface GetCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
     /** Category tree reference details. */
     treeReference: TreeReference;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: SingleEntityOpsRequestedFields[];
 }
 export interface GetCategoryResponse {
@@ -1643,7 +1808,10 @@ export interface UpdateCategoryRequest {
     category: Category;
     /** Category tree reference details. */
     treeReference: TreeReference;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: SingleEntityOpsRequestedFields[];
 }
 export interface UpdateCategoryResponse {
@@ -1651,7 +1819,10 @@ export interface UpdateCategoryResponse {
     category?: Category;
 }
 export interface DeleteCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
     /** Category tree reference details. */
     treeReference: TreeReference;
@@ -1669,7 +1840,10 @@ export interface QueryCategoriesRequest {
      * Default: `false` (only visible categories are returned)
      */
     returnNonVisibleCategories?: boolean;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: RequestedFields[];
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -1687,6 +1861,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -1696,7 +1871,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -1708,13 +1886,17 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 1000
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -1724,7 +1906,10 @@ export declare enum RequestedFields {
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
 export interface QueryCategoriesResponse {
-    /** List of categories. */
+    /**
+     * List of categories.
+     * @maxSize 1000
+     */
     categories?: Category[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
@@ -1743,13 +1928,24 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface ListCompactCategoriesByIdsRequest {
-    /** List of category ids. */
+    /**
+     * List of category ids.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
     categoryIds?: string[];
     /** A reference to the tree that contains the categories. */
     treeReference?: TreeReference;
@@ -1759,9 +1955,16 @@ export interface ListCompactCategoriesByIdsResponse {
     categories?: CompactCategory[];
 }
 export interface CompactCategory {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     id?: string | null;
-    /** Category name. */
+    /**
+     * Category name.
+     * @minLength 1
+     * @maxLength 80
+     */
     name?: string | null;
 }
 export interface SearchCategoriesRequest {
@@ -1778,7 +1981,10 @@ export interface SearchCategoriesRequest {
      * Default: `false` - only visible categories are returned in the response
      */
     returnNonVisibleCategories?: boolean;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: RequestedFields[];
 }
 export interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -1789,9 +1995,15 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
     cursorPaging?: CursorPaging;
     /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
     filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    /**
+     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * @maxSize 10
+     */
     sort?: Sorting[];
-    /** 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. */
+    /**
+     * 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.
+     * @maxSize 10
+     */
     aggregations?: Aggregation[];
     /** Free text to match in searchable fields */
     search?: SearchDetails;
@@ -1803,6 +2015,7 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
      * Affects all filters and aggregations returned values.
      * You may override this behavior in a specific filter by providing
      * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
+     * @maxLength 50
      */
     timeZone?: string | null;
 }
@@ -1825,11 +2038,17 @@ export interface Aggregation extends AggregationKindOneOf {
     dateHistogram?: DateHistogramAggregation;
     /** Nested aggregation */
     nested?: NestedAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * @maxLength 100
+     */
     name?: string | null;
     /** Type of aggregation, client must provide matching aggregation field below */
     type?: AggregationType;
-    /** Field to aggregate by, use dot notation to specify json path */
+    /**
+     * Field to aggregate by, use dot notation to specify json path
+     * @maxLength 200
+     */
     fieldPath?: string;
 }
 /** @oneof */
@@ -1870,7 +2089,10 @@ export declare enum MissingValues {
     INCLUDE = "INCLUDE"
 }
 export interface IncludeMissingValuesOptions {
-    /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
+    /**
+     * Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
+     * @maxLength 20
+     */
     addToBucket?: string;
 }
 export declare enum ScalarType {
@@ -1915,7 +2137,10 @@ export declare enum NestedAggregationType {
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 export interface RangeAggregation {
-    /** 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 */
+    /**
+     * 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
+     * @maxSize 50
+     */
     buckets?: RangeBucket[];
 }
 export interface ScalarAggregation {
@@ -1952,11 +2177,17 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
     scalar?: ScalarAggregation;
     /** Date histogram aggregation */
     dateHistogram?: DateHistogramAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * @maxLength 100
+     */
     name?: string | null;
     /** Type of aggregation client must provide matching aggregation field below */
     type?: NestedAggregationType;
-    /** Field to aggregate by, use dont notation to specify json path */
+    /**
+     * Field to aggregate by, use dont notation to specify json path
+     * @maxLength 200
+     */
     fieldPath?: string;
 }
 /** @oneof */
@@ -1985,18 +2216,27 @@ export declare enum AggregationType {
 }
 /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
 export interface NestedAggregation {
-    /** Flattened list of aggregations, where each next aggregation is nested within previous one */
+    /**
+     * Flattened list of aggregations, where each next aggregation is nested within previous one
+     * @minSize 2
+     * @maxSize 3
+     */
     nestedAggregations?: NestedAggregationItem[];
 }
 export interface SearchDetails {
     /** Defines how separate search terms in `expression` are combined. */
     mode?: Mode;
-    /** Search term or expression. */
+    /**
+     * Search term or expression.
+     * @maxLength 100
+     */
     expression?: string | null;
     /**
      * Fields in which to search for the `expression`. Use dot notation to specify field path.
      *
      * When empty - all searchable fields are looked at.
+     * @maxLength 200
+     * @maxSize 20
      */
     fields?: string[];
     /** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
@@ -2009,7 +2249,10 @@ export declare enum Mode {
     AND = "AND"
 }
 export interface SearchCategoriesResponse {
-    /** List of categories. */
+    /**
+     * List of categories.
+     * @maxSize 1000
+     */
     categories?: Category[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
@@ -2017,11 +2260,17 @@ export interface SearchCategoriesResponse {
     aggregationData?: AggregationData;
 }
 export interface AggregationData {
-    /** key = aggregation name (as derived from search request) */
+    /**
+     * key = aggregation name (as derived from search request)
+     * @maxSize 10000
+     */
     results?: AggregationResults[];
 }
 export interface ValueAggregationResult {
-    /** Value of the field */
+    /**
+     * Value of the field
+     * @maxLength 100
+     */
     value?: string;
     /** Count of entities with this value */
     count?: number;
@@ -2041,11 +2290,17 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
     ranges?: RangeResults;
     /** Scalar aggregation results */
     scalar?: AggregationResultsScalarResult;
-    /** User-defined name of aggregation, matches the one provided in request */
+    /**
+     * User-defined name of aggregation, matches the one provided in request
+     * @maxLength 100
+     */
     name?: string;
     /** Type of aggregation that matches result */
     type?: AggregationType;
-    /** Field to aggregate by, matches the one provided in request */
+    /**
+     * Field to aggregate by, matches the one provided in request
+     * @maxLength 200
+     */
     fieldPath?: string;
 }
 /** @oneof */
@@ -2058,11 +2313,17 @@ export interface NestedAggregationResultsResultOneOf {
     scalar?: AggregationResultsScalarResult;
 }
 export interface ValueResults {
-    /** List of value aggregations */
+    /**
+     * List of value aggregations
+     * @maxSize 250
+     */
     results?: ValueAggregationResult[];
 }
 export interface RangeResults {
-    /** List of ranges returned in same order as requested */
+    /**
+     * List of ranges returned in same order as requested
+     * @maxSize 50
+     */
     results?: RangeAggregationResult[];
 }
 export interface AggregationResultsScalarResult {
@@ -2072,13 +2333,19 @@ export interface AggregationResultsScalarResult {
     value?: number;
 }
 export interface NestedValueAggregationResult {
-    /** Value of the field */
+    /**
+     * Value of the field
+     * @maxLength 1000
+     */
     value?: string;
     /** Nested aggregations */
     nestedResults?: NestedAggregationResults;
 }
 export interface ValueResult {
-    /** Value of the field */
+    /**
+     * Value of the field
+     * @maxLength 1000
+     */
     value?: string;
     /** Count of entities with this value */
     count?: number | null;
@@ -2121,17 +2388,26 @@ export interface Results {
     results?: Record<string, NestedResultValue>;
 }
 export interface DateHistogramResult {
-    /** Date in ISO 8601 format */
+    /**
+     * Date in ISO 8601 format
+     * @maxLength 100
+     */
     value?: string;
     /** Count of documents in the bucket */
     count?: number;
 }
 export interface GroupByValueResults {
-    /** List of value aggregations */
+    /**
+     * List of value aggregations
+     * @maxSize 1000
+     */
     results?: NestedValueAggregationResult[];
 }
 export interface DateHistogramResults {
-    /** List of date histogram aggregations */
+    /**
+     * List of date histogram aggregations
+     * @maxSize 200
+     */
     results?: DateHistogramResult[];
 }
 /**
@@ -2139,7 +2415,10 @@ export interface DateHistogramResults {
  * aggregations in resulting array are keyed by requested aggregation `name`.
  */
 export interface NestedResults {
-    /** List of nested aggregations */
+    /**
+     * List of nested aggregations
+     * @maxSize 1000
+     */
     results?: Results[];
 }
 export interface AggregationResults extends AggregationResultsResultOneOf {
@@ -2155,11 +2434,17 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
     dateHistogram?: DateHistogramResults;
     /** Nested aggregation results */
     nested?: NestedResults;
-    /** User-defined name of aggregation as derived from search request */
+    /**
+     * User-defined name of aggregation as derived from search request
+     * @maxLength 100
+     */
     name?: string;
     /** Type of aggregation that must match provided kind as derived from search request */
     type?: AggregationType;
-    /** Field to aggregate by as derived from search request */
+    /**
+     * Field to aggregate by as derived from search request
+     * @maxLength 200
+     */
     fieldPath?: string;
 }
 /** @oneof */
@@ -2184,7 +2469,10 @@ export interface DeprecatedSearchCategoriesWithOffsetRequest {
     treeReference?: TreeReference;
     /** Whether to return categories with `visible:false`. Default: false so only visible categories will be in response. */
     returnNonVisibleCategories?: boolean;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: RequestedFields[];
 }
 export interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
@@ -2192,9 +2480,15 @@ export interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
     paging?: Paging;
     /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
     filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    /**
+     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * @maxSize 10
+     */
     sort?: Sorting[];
-    /** 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. */
+    /**
+     * 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.
+     * @maxSize 10
+     */
     aggregations?: Aggregation[];
     /** Free text to match in searchable fields */
     search?: SearchDetails;
@@ -2206,6 +2500,7 @@ export interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
      * Affects all filters and aggregations returned values.
      * You may override this behavior in a specific filter by providing
      * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
+     * @maxLength 50
      */
     timeZone?: string | null;
 }
@@ -2215,13 +2510,19 @@ export interface OffsetSearchPagingMethodOneOf {
     paging?: Paging;
 }
 export interface Paging {
-    /** Number of items to load. */
+    /**
+     * Number of items to load.
+     * @max 1000
+     */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
 export interface DeprecatedSearchCategoriesWithOffsetResponse {
-    /** Categories which satisfy the provided query. */
+    /**
+     * Categories which satisfy the provided query.
+     * @maxSize 1000
+     */
     categories?: Category[];
     /** Paging metadata. */
     pagingMetadata?: PagingMetadata;
@@ -2261,7 +2562,10 @@ export interface CountCategoriesResponse {
     count?: number;
 }
 export interface MoveCategoryRequest {
-    /** ID of the category to move. */
+    /**
+     * ID of the category to move.
+     * @format GUID
+     */
     categoryId: string;
     /** Category tree reference details. */
     treeReference: TreeReference;
@@ -2269,6 +2573,7 @@ export interface MoveCategoryRequest {
      * Parent category ID.
      *
      * Default: root category ID
+     * @format GUID
      */
     parentCategoryId?: string | null;
     /**
@@ -2279,7 +2584,10 @@ export interface MoveCategoryRequest {
      * + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
      */
     position: Position;
-    /** Required when passing `position: AFTER`. */
+    /**
+     * Required when passing `position: AFTER`.
+     * @format GUID
+     */
     moveAfterCategoryId?: string | null;
 }
 export declare enum Position {
@@ -2289,13 +2597,24 @@ export declare enum Position {
     AFTER = "AFTER"
 }
 export interface MoveCategoryResponse {
-    /** Parent category ID. */
+    /**
+     * Parent category ID.
+     * @format GUID
+     */
     parentCategoryId?: string | null;
-    /** List of category IDs in the new order of arrangement. */
+    /**
+     * List of category IDs in the new order of arrangement.
+     * @format GUID
+     * @maxSize 100
+     */
     categoriesAfterMove?: string[];
 }
 export interface BulkCreateCategoriesRequest {
-    /** List of categories to be created. */
+    /**
+     * List of categories to be created.
+     * @minSize 1
+     * @maxSize 100
+     */
     categories?: Category[];
     /** Category tree reference details. */
     treeReference?: TreeReference;
@@ -2305,11 +2624,18 @@ export interface BulkCreateCategoriesRequest {
      * Default: `false`
      */
     returnEntity?: boolean;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: RequestedFields[];
 }
 export interface BulkCreateCategoriesResponse {
-    /** Categories created by bulk action. */
+    /**
+     * Categories created by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkCategoriesResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -2325,7 +2651,10 @@ export interface BulkCategoriesResult {
     category?: Category;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
     id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
@@ -2351,7 +2680,11 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface BulkUpdateCategoriesRequest {
-    /** List of categories to update. */
+    /**
+     * List of categories to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     categories: MaskedCategory[];
     /** Category tree reference details. */
     treeReference: TreeReference;
@@ -2361,7 +2694,10 @@ export interface BulkUpdateCategoriesRequest {
      * Default: `false`
      */
     returnEntity?: boolean;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: RequestedFields[];
 }
 export interface MaskedCategory {
@@ -2369,13 +2705,20 @@ export interface MaskedCategory {
     category?: Category;
 }
 export interface BulkUpdateCategoriesResponse {
-    /** Categories updated by bulk action. */
+    /**
+     * Categories updated by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkCategoriesResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface UpdateCategoryVisibilityRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
     /**
      * Whether the category is visible to site visitors in dynamic pages.
@@ -2391,7 +2734,10 @@ export interface UpdateCategoryVisibilityRequest {
      * To prevent conflicting changes, the current revision must be passed on update.
      */
     revision: string | null;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: SingleEntityOpsRequestedFields[];
 }
 export interface UpdateCategoryVisibilityResponse {
@@ -2399,7 +2745,12 @@ export interface UpdateCategoryVisibilityResponse {
     category?: Category;
 }
 export interface BulkShowCategoriesRequest {
-    /** IDs of the categories to update. */
+    /**
+     * IDs of the categories to update.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     categoryIds: string[];
     /** Category tree reference details. */
     treeReference: TreeReference;
@@ -2409,11 +2760,18 @@ export interface BulkShowCategoriesRequest {
      * Default: `false`
      */
     returnEntity?: boolean;
-    /** Fields to include in the response. */
+    /**
+     * Fields to include in the response.
+     * @maxSize 100
+     */
     fields?: RequestedFields[];
 }
 export interface BulkShowCategoriesResponse {
-    /** Categories updated by bulk action. */
+    /**
+     * Categories updated by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkCategoriesResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -2438,15 +2796,25 @@ export interface BulkUpdateCategoryVisibilityByFilterResponse {
      * Job ID.
      *
      * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
+     * @format GUID
      */
     jobId?: string;
 }
 export interface BulkDeleteCategoriesRequest {
-    /** IDs of categories to be deleted. */
+    /**
+     * IDs of categories to be deleted.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     categoryIds?: string[];
 }
 export interface BulkDeleteCategoriesResponse {
-    /** Categories deleted by bulk action. */
+    /**
+     * Categories deleted by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkDeleteCategoriesResponseBulkCategoriesResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -2473,19 +2841,31 @@ export interface BulkDeleteCategoriesByFilterResponse {
      * Job ID.
      *
      * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
+     * @format GUID
      */
     jobId?: string;
 }
 export interface BulkAddItemsToCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
-    /** List of items to add. */
+    /**
+     * List of items to add.
+     * @minSize 1
+     * @maxSize 1000
+     */
     items: ItemReference[];
     /** Category tree reference details. */
     treeReference: TreeReference;
 }
 export interface BulkAddItemsToCategoryResponse {
-    /** List of items added to a category by bulk action. */
+    /**
+     * List of items added to a category by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkItemsToCategoryResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -2510,13 +2890,22 @@ export interface ItemReferenceMetadata {
 export interface BulkAddItemToCategoriesRequest {
     /** Item to add. */
     item: ItemReference;
-    /** IDs of categories to which to add the item. */
+    /**
+     * IDs of categories to which to add the item.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     categoryIds: string[];
     /** Category tree reference details. */
     treeReference: TreeReference;
 }
 export interface BulkAddItemToCategoriesResponse {
-    /** Items added by bulk action. */
+    /**
+     * Items added by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkItemToCategoriesResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -2526,15 +2915,26 @@ export interface BulkItemToCategoriesResult {
     itemMetadata?: ItemMetadata;
 }
 export interface BulkRemoveItemsFromCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
-    /** List of items to remove. */
+    /**
+     * List of items to remove.
+     * @minSize 1
+     * @maxSize 100
+     */
     items: ItemReference[];
     /** Category tree reference details. */
     treeReference: TreeReference;
 }
 export interface BulkRemoveItemsFromCategoryResponse {
-    /** Items removed by bulk action. */
+    /**
+     * Items removed by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkItemsToCategoryResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -2542,13 +2942,22 @@ export interface BulkRemoveItemsFromCategoryResponse {
 export interface BulkRemoveItemFromCategoriesRequest {
     /** Item to remove. */
     item: ItemReference;
-    /** IDs of categories from which to remove the item. */
+    /**
+     * IDs of categories from which to remove the item.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     categoryIds: string[];
     /** Category tree reference details. */
     treeReference: TreeReference;
 }
 export interface BulkRemoveItemFromCategoriesResponse {
-    /** Items removed by bulk action. */
+    /**
+     * Items removed by bulk action.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkItemToCategoriesResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -2560,7 +2969,10 @@ export interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPa
      * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
      */
     cursorPaging?: CursorPaging;
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
     /** Category tree reference details. */
     treeReference: TreeReference;
@@ -2587,7 +2999,10 @@ export interface ListItemsInCategoryRequestPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface ListItemsInCategoryResponse {
-    /** List of items in the category. */
+    /**
+     * List of items in the category.
+     * @maxSize 100
+     */
     items?: ItemReference[];
     /** Paging metadata. */
     pagingMetadata?: PagingMetadataV2;
@@ -2609,37 +3024,65 @@ export interface ListCategoriesForItemRequest {
     treeReference: TreeReference;
 }
 export interface ListCategoriesForItemResponse {
-    /** List of IDs of categories that directly contain this item. */
+    /**
+     * List of IDs of categories that directly contain this item.
+     * @format GUID
+     * @maxSize 1000
+     */
     directCategoryIds?: string[];
-    /** List of IDs of categories that directly contain this item, and their parent category IDs. */
+    /**
+     * List of IDs of categories that directly contain this item, and their parent category IDs.
+     * @format GUID
+     * @maxSize 1000
+     */
     allCategoryIds?: string[];
 }
 export interface ListCategoriesForItemsRequest {
-    /** List of Item reference info. */
+    /**
+     * List of Item reference info.
+     * @maxSize 100
+     */
     items: ItemReference[];
     /** Category tree reference details. */
     treeReference: TreeReference;
 }
 export interface ListCategoriesForItemsResponse {
-    /** Map of item references to lists of direct category IDs and all category IDs, including parent categories and direct ones. */
+    /**
+     * Map of item references to lists of direct category IDs and all category IDs, including parent categories and direct ones.
+     * @maxSize 100
+     */
     categoriesForItems?: MapItemToCategories[];
 }
 export interface MapItemToCategories {
     /** Item reference info. */
     item?: ItemReference;
-    /** List of IDs of categories that directly contain this item. */
+    /**
+     * List of IDs of categories that directly contain this item.
+     * @format GUID
+     * @maxSize 1000
+     */
     directCategoryIds?: string[];
-    /** List of IDs of categories that indirectly contain this item, including all ancestors of its direct categories in the hierarchy. */
+    /**
+     * List of IDs of categories that indirectly contain this item, including all ancestors of its direct categories in the hierarchy.
+     * @format GUID
+     * @maxSize 1000
+     */
     indirectCategoryIds?: string[];
 }
 export interface ListTreesRequest {
 }
 export interface ListTreesResponse {
-    /** List of trees. */
+    /**
+     * List of trees.
+     * @maxSize 20
+     */
     trees?: TreeReference[];
 }
 export interface MoveItemInCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
     /** Category tree reference details. */
     treeReference?: TreeReference;
@@ -2664,29 +3107,47 @@ export declare enum MoveItemInCategoryRequestPosition {
     NONE = "NONE"
 }
 export interface MoveItemInCategoryResponse {
-    /** Information about manually arranged items after move. */
+    /**
+     * Information about manually arranged items after move.
+     * @maxSize 100
+     */
     itemsAfterMove?: ItemReference[];
 }
 export interface SetArrangedItemsRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
     /** Category tree reference details. */
     treeReference: TreeReference;
-    /** List of items to set. */
+    /**
+     * List of items to set.
+     * @maxSize 100
+     */
     items?: ItemReference[];
 }
 export interface SetArrangedItemsResponse {
-    /** List of arranged items. */
+    /**
+     * List of arranged items.
+     * @maxSize 100
+     */
     items?: ItemReference[];
 }
 export interface GetArrangedItemsRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId: string;
     /** Category tree reference details. */
     treeReference: TreeReference;
 }
 export interface GetArrangedItemsResponse {
-    /** List of arranged items. */
+    /**
+     * List of arranged items.
+     * @maxSize 100
+     */
     items?: ItemReference[];
 }
 export interface GetCategoriesTreeRequest {
@@ -2701,7 +3162,10 @@ export interface GetCategoriesTreeResponse {
 export interface CategoryTreeNode {
     /** Category ID. */
     id?: Uint8Array;
-    /** List of subcategories. */
+    /**
+     * List of subcategories.
+     * @maxSize 1000
+     */
     subcategories?: CategoryTreeNode[];
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -2779,9 +3243,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -2789,26 +3259,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {