@wix/auto_sdk_stores_read-only-variants-v-3 1.0.44 → 1.0.46

package/build/{internal/cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-11ZHjQPT.d.ts → cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BmO0mCp5.d.ts}

@@ -1731,14 +1731,14 @@ interface Product extends ProductTypedPropertiesOneOf {
     /**
      * Product description in HTML.
      *
-     * + When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
-     * + `plainDescription` is ignored when value is also passed to the `description` field.
+     * + When provided on create/update, this string must be valid HTML. It's then converted to rich content.
+     * + `plainDescription` is ignored when a value is also passed to the `description` field.
      * > **Note:** Returned only when you pass `"PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
      * @maxLength 16000
      */
     plainDescription?: string | null;
     /**
-     * Whether the product is visible to site visitors on the site.
+     * Whether the product is visible to site visitors.
      *
      * Default: `true`
      */
@@ -1755,34 +1755,35 @@ interface Product extends ProductTypedPropertiesOneOf {
     /** Product SEO data. */
     seoData?: SeoSchema;
     /**
-     * Tax group ID.
+     * [Tax group ID](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/tax/tax-groups/introduction). Used to apply specific tax rates to products.
      * @format GUID
      */
     taxGroupId?: string | null;
     /**
-     * Product options. Allows the customer to customize the product. For example, selecting color, size, and more.
+     * Product options. Each option (like "Size" or "Color") creates variants when combined with other options.
      *
-     * Always generates variants: every variant must have exactly one choice related to each option.
-     * Since options and variants tightly coupled and rely on each other they usually should be provided together in all operations.
+     * When you provide options, you must also provide the corresponding variants. Each variant must have exactly one choice for each option.
+     * To use existing [customizations](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction), pass their IDs. Otherwise, new customization entities are automatically created.
      * @maxSize 6
      */
     options?: ConnectedOption[];
     /**
-     * Product modifiers.
+     * Product modifiers. Collect additional information from customers without creating variants.
      *
-     * Allows the customer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any variants.
+     * Unlike options, modifiers don't affect inventory or create additional variants. Use them for customizations like gift messages or engraving text.
+     * To use existing [customizations](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction), pass their IDs. Otherwise, new customization entities are automatically created.
      * @maxSize 10
      */
     modifiers?: ConnectedModifier[];
     /**
-     * Product brand.
+     * Product [brand](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/introduction).
      *
      * + Pass `brand.name` to add a new brand while creating a product.
      * + Pass an existing brand's `id` to assign that brand to the product.
      */
     brand?: Brand;
     /**
-     * Product info section.
+     * Product [info section](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/info-sections-v3/introduction).
      *
      * + Pass `infoSection.uniqueName`, `infoSection.title`, and `infoSection.description` to add a new info section while creating a product.
      * + Pass an existing info section's `id` or `uniqueName` to assign that info section to the product.
@@ -1790,14 +1791,14 @@ interface Product extends ProductTypedPropertiesOneOf {
      */
     infoSections?: InfoSection[];
     /**
-     * Product ribbon.
+     * Product [ribbon](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/introduction).
      *
      * + Pass `ribbon.name` to add a new ribbon while creating a product.
      * + Pass an existing ribbon's `id` or `name` to assign that ribbon to the product.
      */
     ribbon?: Ribbon;
     /**
-     * List of categories that directly contain this product.
+     * List of [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction) that directly contain this product.
      *
      * Updated automatically when a product is added/removed from a category, when an item is moved within a category, or when a category is deleted.
      * > **Note:** Returned only when you pass `"DIRECT_CATEGORIES_INFO"` to the `fields` array in Products API requests.
@@ -1805,13 +1806,13 @@ interface Product extends ProductTypedPropertiesOneOf {
      */
     directCategoriesInfo?: ProductCategoriesInfo;
     /**
-     * List of categories that directly contain this product, as well as their parent categories.
+     * List of [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction) that directly contain this product, as well as their parent categories.
      * > **Note:** Returned only when you pass `"ALL_CATEGORIES_INFO"` to the `fields` array in Products API requests.
      * @readonly
      */
     allCategoriesInfo?: ProductCategoriesInfo;
     /**
-     * The ID of the product's primary direct category, which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
+     * The ID of the product's primary direct [category](https://dev.wix.com/docs/api-reference/business-management/categories/introduction), which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
      * @format GUID
      */
     mainCategoryId?: string | null;
@@ -1826,62 +1827,52 @@ interface Product extends ProductTypedPropertiesOneOf {
     costRange?: PriceRange;
     /**
      * Product inventory info.
+     *
+     * > **Note:** This field reflects the aggregated inventory status from the default location only. Use the [Inventory Items API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/introduction) to manage inventory for specific locations.
      * @readonly
      */
     inventory?: Inventory;
     /**
-     * Product type.
+     * Product type: `PHYSICAL` for tangible goods that require shipping, or `DIGITAL` for downloadable content.
      *
-     * When passing `productType: PHYSICAL`, you must also pass `physicalProperties`.
+     * When passing `productType: PHYSICAL`, you must also pass `physicalProperties`. When passing `productType: DIGITAL`, you can optionally pass `digitalProperties` in each variant.
      * @immutable
      */
     productType?: ProductTypeWithLiterals;
     /**
      * A unique human-friendly identifier for the product.
-     * Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.
-     * In case handle wasn't given, the handle will be automatically generated.
+     *
+     * Unlike the auto-generated `id`, the handle can be set when creating a product. This is useful when re-importing products from other systems, as it provides a stable identifier across platforms. If not provided during creation, one is automatically generated. Can't be changed after creation.
      * @minLength 1
      * @maxLength 100
      * @readonly
      */
     handle?: string | null;
-    /**
-     * ID of the last import job that affected the product.
-     * @internal
-     * @format GUID
-     */
-    importId?: string | null;
     /**
      * Currency used for the pricing of this product, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
      *
-     * Defaults to the currency defined in the site settings, unless specified in `x-wix-currency` header.
+     * Defaults to the currency defined in the site settings, unless specified in the request's `x-wix-currency` header.
      * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
      * @format CURRENCY
      * @readonly
      */
     currency?: string | null;
     /**
-     * Breadcrumbs of the `mainCategoryId`. Used to navigate to parent categories.
+     * Breadcrumbs of the `mainCategoryId`. Used to navigate to parent [categories](https://dev.wix.com/docs/api-reference/business-management/categories/introduction).
      * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Products API requests.
      * @readonly
      */
     breadcrumbsInfo?: BreadcrumbsInfo;
     /**
-     * Product actualPrice range - minimum and maximum prices of all product variants.
+     * Minimum and maximum current selling prices across all product variants.
      * @readonly
      */
     actualPriceRange?: PriceRange;
     /**
-     * Product compareAtPrice range - minimum and maximum compare at prices of all product variants.
+     * Minimum and maximum compare-at prices (original prices before discounts) across all product variants. Used to show savings to customers.
      * @readonly
      */
     compareAtPriceRange?: PriceRange;
-    /**
-     * Optional - ID of the app that manages the inventory for this product.
-     * @internal
-     * @format GUID
-     */
-    inventoryAppId?: string | null;
     /**
      * Product variants. Each variant must reference all product options via its `choices` array.
      * Each choice references an option using `optionChoiceNames` for all requests.
@@ -1890,10 +1881,14 @@ interface Product extends ProductTypedPropertiesOneOf {
     /**
      * Custom extended fields for the product object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
-    /** Product subscriptions. */
+    /**
+     * Product subscriptions.
+     *
+     * Subscription discounts are defined at the product level but apply to each variant's `actualPrice`. This means the final subscription price varies per variant based on the variant's base price.
+     */
     subscriptionDetails?: SubscriptionDetails;
     /**
      * The total number of variants for the product.
@@ -3795,6 +3790,7 @@ interface TextNodeStyle {
 interface Media {
     /**
      * Main media (image, video, etc.) associated with this product.
+     * Automatically set to the first item in the media list.
      * @readonly
      */
     main?: ProductMedia;
@@ -4287,7 +4283,7 @@ interface Ribbon {
 }
 interface ProductCategoriesInfo {
     /**
-     * A list of categories related to product.
+     * A list of categories related to the product.
      * @readonly
      * @maxSize 2000
      */
@@ -4300,14 +4296,14 @@ interface ProductCategory {
      */
     _id?: string;
     /**
-     * Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow.
+     * Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in a category](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-a-category) sample flow.
      * @max 200
      */
     index?: number | null;
 }
 interface ProductCategoryIdsInfo {
     /**
-     * A list of category ids related to product.
+     * A list of category ids related to the product.
      * @readonly
      * @maxSize 2000
      * @format GUID
@@ -4547,9 +4543,11 @@ interface Variant extends VariantTypedPropertiesOneOf {
      */
     barcode?: string | null;
     /**
-     * List of choices that define the product's variant, which requires exactly one choice per product option.
+     * List of choices that define this variant. Each variant must have exactly one choice for each product option.
+     *
      * Must use `optionChoiceNames` in all requests this field is required.
-     * Empty only for default variants of unmanaged products.
+     *
+     * For products without options, this array is empty, representing a single "default variant".
      * @maxSize 6
      * @immutable
      */
@@ -4628,9 +4626,9 @@ interface OptionChoiceNames {
     renderType?: ProductOptionRenderTypeWithLiterals;
 }
 interface PriceInfo {
-    /** Variant price. Must be greater or equal to 0. */
+    /** Variant's current selling price. Must be greater than or equal to 0. */
     actualPrice?: FixedMonetaryAmount;
-    /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
+    /** Original price before any discount, shown with a strikethrough in the UI of Wix sites. Only set this if a discount applies. When set, it should be higher than `actualPrice` to reflect savings. */
     compareAtPrice?: FixedMonetaryAmount;
 }
 interface RevenueDetails {
@@ -4685,7 +4683,10 @@ interface PricePerUnit {
     description?: string | null;
 }
 interface VariantDigitalProperties {
-    /** Digital file which will be downloaded by customer after successful purchase. */
+    /**
+     * Digital file which will be downloaded by the buyer after successful purchase.
+     * Each variant can have a different digital file, allowing you to offer different content per variant.
+     */
     digitalFile?: SecuredMedia;
 }
 interface SecuredMedia {
@@ -4803,13 +4804,6 @@ interface SubscriptionDetails {
      * Default: `false`
      */
     allowOneTimePurchases?: boolean | null;
-    /**
-     * Whether to add a 'Cancel subscription' button to the My Subscriptions tab of the [Members Area page](https://support.wix.com/en/article/site-members-about-the-members-area).
-     *
-     * Default: `false`
-     * @internal
-     */
-    enableCustomerCancellation?: boolean | null;
 }
 interface Subscription extends SubscriptionCyclesOneOf {
     /** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
@@ -5120,6 +5114,12 @@ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYM
  * For complex queries with free-text search and aggregations, use Search Variants instead.
  *
  * Up to 1,000 variants can be returned per request.
+ *
+ * To learn about working with _Query_ endpoints, see
+ * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
+ * and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
+ *
+ * Learn more about the differences between [_Query_ and _Search_](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods) methods.
  * @public
  * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ
  * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN

package/build/es/index.d.mts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { R as ReadOnlyVariantSearch, S as SearchVariantsOptions, a as SearchVariantsResponse, b as ReadOnlyVariantQuery, Q as QueryVariantsOptions, t as typedQueryVariants, V as VariantsQueryBuilder } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-D4WyK7_Y.mjs';
-export { eN as ActionEvent, b6 as Aggregation, bj as AggregationData, bQ as AggregationDateHistogramAggregation, b7 as AggregationKindOneOf, bT as AggregationNestedAggregation, bO as AggregationRangeAggregation, bC as AggregationResults, bD as AggregationResultsResultOneOf, bq as AggregationResultsScalarResult, bP as AggregationScalarAggregation, A as AggregationType, f7 as AggregationTypeWithLiterals, bM as AggregationValueAggregation, bN as AggregationValueAggregationOptionsOneOf, a8 as Alignment, fM as AlignmentWithLiterals, d0 as AnchorData, d7 as AppEmbedData, d8 as AppEmbedDataAppDataOneOf, aa as AppType, fO as AppTypeWithLiterals, a4 as AspectRatio, fI as AspectRatioWithLiterals, dt as AudioData, ao as AvailabilityStatus, g0 as AvailabilityStatusWithLiterals, cS as Background, cT as BackgroundBackgroundOneOf, dz as BackgroundImage, a0 as BackgroundType, fE as BackgroundTypeWithLiterals, dw as BlockquoteData, d9 as BookingData, c6 as Border, dq as BorderColors, dr as BorderWidths, d$ as Brand, ef as BreadCrumb, ee as BreadcrumbsInfo, dv as BulletedListData, c5 as ButtonData, B as ButtonDataType, fl as ButtonDataTypeWithLiterals, db as ButtonStyles, dx as CaptionData, de as CardStyles, dp as CellStyle, am as ChoiceType, f_ as ChoiceTypeWithLiterals, dR as ChoicesSettings, ch as CodeBlockData, dk as CollapsibleListData, d1 as ColorData, c7 as Colors, bI as CommonAggregation, bJ as CommonAggregationKindOneOf, r as CommonAggregationType, fg as CommonAggregationTypeWithLiterals, g8 as CommonQueryWithEntityContext, p as CommonScalarType, fd as CommonScalarTypeWithLiterals, bW as CommonSearchDetails, g9 as CommonSearchWithEntityContext, C as CommonSortOrder, f9 as CommonSortOrderWithLiterals, bH as CommonSorting, aH as CommonVideoResolution, dV as ConnectedModifier, dZ as ConnectedModifierChoice, d_ as ConnectedModifierChoiceValueOneOf, dW as ConnectedModifierModifierSettingsOneOf, dP as ConnectedOption, dS as ConnectedOptionChoice, dT as ConnectedOptionChoiceValueOneOf, dQ as ConnectedOptionOptionSettingsOneOf, G as Crop, fu as CropWithLiterals, a$ as CursorPaging, b1 as CursorPagingMetadata, aY as CursorQuery, aZ as CursorQueryPagingMethodOneOf, b4 as CursorSearch, b5 as CursorSearchPagingMethodOneOf, b2 as Cursors, be as DateHistogramAggregation, D as DateHistogramAggregationInterval, ff as DateHistogramAggregationIntervalWithLiterals, by as DateHistogramResult, bA as DateHistogramResults, c_ as Decoration, c$ as DecorationDataOneOf, a1 as DecorationType, fF as DecorationTypeWithLiterals, bE as DeprecatedSearchVariantsWithOffsetRequest, bY as DeprecatedSearchVariantsWithOffsetResponse, cY as Design, aj as DesignTarget, fX as DesignTargetWithLiterals, dm as Dimensions, ac as Direction, fQ as DirectionWithLiterals, au as DiscountType, g6 as DiscountTypeWithLiterals, cj as DividerData, z as DividerDataAlignment, fq as DividerDataAlignmentWithLiterals, dC as DocumentStyle, eH as DomainEvent, eI as DomainEventBodyOneOf, di as EmbedData, eO as Empty, eJ as EntityCreatedEvent, eM as EntityDeletedEvent, eL as EntityUpdatedEvent, da as EventData, ew as ExtendedFields, ck as FileData, cl as FileSource, cm as FileSourceDataOneOf, as as FileType, g4 as FileTypeWithLiterals, e6 as FixedMonetaryAmount, d6 as FontFamilyData, d4 as FontSizeData, a2 as FontType, fG as FontTypeWithLiterals, dX as FreeTextSettings, cz as GIF, cy as GIFData, J as GIFType, fw as GIFTypeWithLiterals, co as GalleryData, cu as GalleryOptions, cv as GalleryOptionsLayout, cR as Gradient, bU as GroupByAggregation, bV as GroupByAggregationKindOneOf, bz as GroupByValueResults, cB as HTMLData, cC as HTMLDataDataOneOf, cA as HeadingData, cc as Height, eQ as IdentificationData, eR as IdentificationDataIdOneOf, cq as Image, cD as ImageData, cF as ImageDataStyles, ag as ImagePosition, fU as ImagePositionWithLiterals, dc as ImageStyles, b9 as IncludeMissingValuesOptions, e0 as InfoSection, ab as InitialExpandedItems, fP as InitialExpandedItemsWithLiterals, aW as InternalMetadata, I as InternalRowState, e_ as InternalRowStateWithLiterals, k as Interval, f6 as IntervalWithLiterals, e7 as Inventory, ev as InventoryStatus, cs as Item, ct as ItemDataOneOf, cw as ItemStyle, dM as Keyword, a9 as Layout, dA as LayoutCellData, dy as LayoutData, F as LayoutType, fs as LayoutTypeWithLiterals, fN as LayoutWithLiterals, L as LineStyle, fo as LineStyleWithLiterals, ce as Link, d2 as LinkData, cf as LinkDataOneOf, cG as LinkPreviewData, cH as LinkPreviewDataStyles, ds as ListValue, cI as MapData, cJ as MapSettings, X as MapType, fz as MapTypeWithLiterals, M as MeasurementUnit, eW as MeasurementUnitWithLiterals, dE as Media, dK as MediaItemsInfo, ak as MediaType, fY as MediaTypeWithLiterals, d3 as MentionData, eP as MessageEnvelope, dB as Metadata, b_ as MigrateProductVariantsRequest, eE as MigrateProductVariantsResponse, eD as MinVariantPriceInfo, i as MissingValues, f3 as MissingValuesWithLiterals, l as Mode, f8 as ModeWithLiterals, dY as ModifierChoicesSettings, an as ModifierRenderType, f$ as ModifierRenderTypeWithLiterals, dU as MultipleColors, bh as NestedAggregation, bf as NestedAggregationItem, bg as NestedAggregationItemKindOneOf, bR as NestedAggregationNestedAggregationItem, bS as NestedAggregationNestedAggregationItemKindOneOf, q as NestedAggregationNestedAggregationType, fe as NestedAggregationNestedAggregationTypeWithLiterals, bm as NestedAggregationResults, bn as NestedAggregationResultsResultOneOf, N as NestedAggregationType, f5 as NestedAggregationTypeWithLiterals, bv as NestedResultValue, bw as NestedResultValueResultOneOf, bB as NestedResults, br as NestedValueAggregationResult, c2 as Node, c3 as NodeDataOneOf, c4 as NodeStyle, u as NodeType, fi as NodeTypeWithLiterals, ae as NullValue, fS as NullValueWithLiterals, dj as Oembed, cN as Option, ej as OptionChoice, ek as OptionChoiceIds, el as OptionChoiceNames, cV as OptionDesign, cQ as OptionLayout, du as OrderedListData, O as Orientation, ft as OrientationWithLiterals, cn as PDFSettings, bZ as PagingMetadata, cK as ParagraphData, cM as Permissions, e8 as PhysicalProperties, a6 as Placement, fK as PlacementWithLiterals, bF as PlatformOffsetSearch, bG as PlatformOffsetSearchPagingMethodOneOf, bX as PlatformPaging, dh as PlaybackOptions, c8 as PluginContainerData, w as PluginContainerDataAlignment, fk as PluginContainerDataAlignmentWithLiterals, c9 as PluginContainerDataWidth, ca as PluginContainerDataWidthDataOneOf, cW as Poll, cL as PollData, cX as PollDataLayout, cU as PollDesign, cP as PollLayout, $ as PollLayoutDirection, fD as PollLayoutDirectionWithLiterals, _ as PollLayoutType, fC as PollLayoutTypeWithLiterals, cO as PollSettings, a3 as Position, fH as PositionWithLiterals, ap as PreorderStatus, g1 as PreorderStatusWithLiterals, em as PriceInfo, ep as PricePerUnit, eb as PricePerUnitRange, ec as PricePerUnitRangePricePerUnit, e9 as PricePerUnitSettings, e5 as PriceRange, df as PricingData, b$ as Product, e2 as ProductCategoriesInfo, e3 as ProductCategory, e4 as ProductCategoryIdsInfo, aS as ProductFields, aT as ProductFieldsTypedPropertiesOneOf, dF as ProductMedia, dH as ProductMediaMediaOneOf, P as ProductMediaMediaType, eV as ProductMediaMediaTypeWithLiterals, dG as ProductMediaSetByOneOf, al as ProductOptionRenderType, fZ as ProductOptionRenderTypeWithLiterals, aq as ProductPreorderAvailability, g2 as ProductPreorderAvailabilityWithLiterals, ar as ProductType, g3 as ProductTypeWithLiterals, c0 as ProductTypedPropertiesOneOf, aX as QueryVariantsRequest, b0 as QueryVariantsResponse, bc as RangeAggregation, bK as RangeAggregationRangeBucket, bl as RangeAggregationResult, b8 as RangeBucket, bt as RangeResult, bp as RangeResults, aw as ReadOnlyVariant, eT as ReadOnlyVariantQuerySpec, eU as ReadOnlyVariantSearchSpec, ax as ReadOnlyVariantTypedPropertiesOneOf, eF as RecoverProductVariantsRequest, eG as RecoverProductVariantsResponse, cg as Rel, f as RequestedFields, f0 as RequestedFieldsWithLiterals, a5 as Resizing, fJ as ResizingWithLiterals, ai as ResponsivenessBehaviour, fW as ResponsivenessBehaviourWithLiterals, eK as RestoreInfo, bx as Results, en as RevenueDetails, e1 as Ribbon, dd as RibbonStyles, c1 as RichContent, bd as ScalarAggregation, bu as ScalarResult, j as ScalarType, f4 as ScalarTypeWithLiterals, af as Scaling, fT as ScalingWithLiterals, bi as SearchDetails, s as SearchDetailsMode, fh as SearchDetailsModeWithLiterals, b3 as SearchVariantsRequest, er as SecuredMedia, c as SecuredMediaFileType, eX as SecuredMediaFileTypeWithLiterals, dL as SeoSchema, dO as Settings, h as SortDirection, f2 as SortDirectionWithLiterals, e as SortOrder, e$ as SortOrderWithLiterals, g as SortType, f1 as SortTypeWithLiterals, a_ as Sorting, K as Source, fx as SourceWithLiterals, cb as Spoiler, d5 as SpoilerData, cd as Styles, cE as StylesBorder, U as StylesPosition, fy as StylesPositionWithLiterals, ey as Subscription, ez as SubscriptionCyclesOneOf, ex as SubscriptionDetails, eA as SubscriptionDiscount, eB as SubscriptionDiscountDiscountOneOf, at as SubscriptionFrequency, g5 as SubscriptionFrequencyWithLiterals, et as SubscriptionPrice, eu as SubscriptionPricePerUnit, es as SubscriptionPricesInfo, dn as TableCellData, dl as TableData, dN as Tag, T as Target, fm as TargetWithLiterals, x as TextAlignment, fn as TextAlignmentWithLiterals, cZ as TextData, dD as TextNodeStyle, ci as TextStyle, dJ as Thumbnail, cx as Thumbnails, H as ThumbnailsAlignment, fv as ThumbnailsAlignmentWithLiterals, a7 as Type, fL as TypeWithLiterals, cp as V1Media, aC as V3FixedMonetaryAmount, aR as V3InventoryStatus, ay as V3OptionChoice, az as V3OptionChoiceIds, aA as V3OptionChoiceNames, aU as V3PhysicalProperties, aB as V3PriceInfo, aK as V3PricePerUnit, aL as V3PricePerUnitSettings, aE as V3ProductMedia, aG as V3ProductMediaMediaOneOf, aF as V3ProductMediaSetByOneOf, d as V3ProductType, eY as V3ProductTypeWithLiterals, aD as V3RevenueDetails, aN as V3SecuredMedia, aP as V3SubscriptionPrice, aQ as V3SubscriptionPricePerUnit, aO as V3SubscriptionPricesInfo, aI as V3Thumbnail, aM as V3VariantDigitalProperties, aJ as V3VariantPhysicalProperties, aV as V3WeightMeasurementUnitInfo, ba as ValueAggregation, bL as ValueAggregationIncludeMissingValuesOptions, o as ValueAggregationMissingValues, fc as ValueAggregationMissingValuesWithLiterals, bb as ValueAggregationOptionsOneOf, bk as ValueAggregationResult, n as ValueAggregationSortDirection, fb as ValueAggregationSortDirectionWithLiterals, m as ValueAggregationSortType, fa as ValueAggregationSortTypeWithLiterals, bs as ValueResult, bo as ValueResults, eh as Variant, eq as VariantDigitalProperties, eo as VariantPhysicalProperties, eC as VariantSummary, ei as VariantTypedPropertiesOneOf, eg as VariantsInfo, eS as VariantsQueryResult, ad as VerticalAlignment, ah as VerticalAlignmentAlignment, fV as VerticalAlignmentAlignmentWithLiterals, fR as VerticalAlignmentWithLiterals, cr as Video, dg as VideoData, dI as VideoResolution, E as ViewMode, fr as ViewModeWithLiterals, Y as ViewRole, fA as ViewRoleWithLiterals, Z as VoteRole, fB as VoteRoleWithLiterals, av as WebhookIdentityType, g7 as WebhookIdentityTypeWithLiterals, ed as WeightMeasurementUnitInfo, ea as WeightRange, W as WeightUnit, eZ as WeightUnitWithLiterals, y as Width, v as WidthType, fj as WidthTypeWithLiterals, fp as WidthWithLiterals } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-D4WyK7_Y.mjs';
+import { R as ReadOnlyVariantSearch, S as SearchVariantsOptions, a as SearchVariantsResponse, b as ReadOnlyVariantQuery, Q as QueryVariantsOptions, t as typedQueryVariants, V as VariantsQueryBuilder } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BmO0mCp5.mjs';
+export { eN as ActionEvent, b6 as Aggregation, bj as AggregationData, bQ as AggregationDateHistogramAggregation, b7 as AggregationKindOneOf, bT as AggregationNestedAggregation, bO as AggregationRangeAggregation, bC as AggregationResults, bD as AggregationResultsResultOneOf, bq as AggregationResultsScalarResult, bP as AggregationScalarAggregation, A as AggregationType, f7 as AggregationTypeWithLiterals, bM as AggregationValueAggregation, bN as AggregationValueAggregationOptionsOneOf, a8 as Alignment, fM as AlignmentWithLiterals, d0 as AnchorData, d7 as AppEmbedData, d8 as AppEmbedDataAppDataOneOf, aa as AppType, fO as AppTypeWithLiterals, a4 as AspectRatio, fI as AspectRatioWithLiterals, dt as AudioData, ao as AvailabilityStatus, g0 as AvailabilityStatusWithLiterals, cS as Background, cT as BackgroundBackgroundOneOf, dz as BackgroundImage, a0 as BackgroundType, fE as BackgroundTypeWithLiterals, dw as BlockquoteData, d9 as BookingData, c6 as Border, dq as BorderColors, dr as BorderWidths, d$ as Brand, ef as BreadCrumb, ee as BreadcrumbsInfo, dv as BulletedListData, c5 as ButtonData, B as ButtonDataType, fl as ButtonDataTypeWithLiterals, db as ButtonStyles, dx as CaptionData, de as CardStyles, dp as CellStyle, am as ChoiceType, f_ as ChoiceTypeWithLiterals, dR as ChoicesSettings, ch as CodeBlockData, dk as CollapsibleListData, d1 as ColorData, c7 as Colors, bI as CommonAggregation, bJ as CommonAggregationKindOneOf, r as CommonAggregationType, fg as CommonAggregationTypeWithLiterals, g8 as CommonQueryWithEntityContext, p as CommonScalarType, fd as CommonScalarTypeWithLiterals, bW as CommonSearchDetails, g9 as CommonSearchWithEntityContext, C as CommonSortOrder, f9 as CommonSortOrderWithLiterals, bH as CommonSorting, aH as CommonVideoResolution, dV as ConnectedModifier, dZ as ConnectedModifierChoice, d_ as ConnectedModifierChoiceValueOneOf, dW as ConnectedModifierModifierSettingsOneOf, dP as ConnectedOption, dS as ConnectedOptionChoice, dT as ConnectedOptionChoiceValueOneOf, dQ as ConnectedOptionOptionSettingsOneOf, G as Crop, fu as CropWithLiterals, a$ as CursorPaging, b1 as CursorPagingMetadata, aY as CursorQuery, aZ as CursorQueryPagingMethodOneOf, b4 as CursorSearch, b5 as CursorSearchPagingMethodOneOf, b2 as Cursors, be as DateHistogramAggregation, D as DateHistogramAggregationInterval, ff as DateHistogramAggregationIntervalWithLiterals, by as DateHistogramResult, bA as DateHistogramResults, c_ as Decoration, c$ as DecorationDataOneOf, a1 as DecorationType, fF as DecorationTypeWithLiterals, bE as DeprecatedSearchVariantsWithOffsetRequest, bY as DeprecatedSearchVariantsWithOffsetResponse, cY as Design, aj as DesignTarget, fX as DesignTargetWithLiterals, dm as Dimensions, ac as Direction, fQ as DirectionWithLiterals, au as DiscountType, g6 as DiscountTypeWithLiterals, cj as DividerData, z as DividerDataAlignment, fq as DividerDataAlignmentWithLiterals, dC as DocumentStyle, eH as DomainEvent, eI as DomainEventBodyOneOf, di as EmbedData, eO as Empty, eJ as EntityCreatedEvent, eM as EntityDeletedEvent, eL as EntityUpdatedEvent, da as EventData, ew as ExtendedFields, ck as FileData, cl as FileSource, cm as FileSourceDataOneOf, as as FileType, g4 as FileTypeWithLiterals, e6 as FixedMonetaryAmount, d6 as FontFamilyData, d4 as FontSizeData, a2 as FontType, fG as FontTypeWithLiterals, dX as FreeTextSettings, cz as GIF, cy as GIFData, J as GIFType, fw as GIFTypeWithLiterals, co as GalleryData, cu as GalleryOptions, cv as GalleryOptionsLayout, cR as Gradient, bU as GroupByAggregation, bV as GroupByAggregationKindOneOf, bz as GroupByValueResults, cB as HTMLData, cC as HTMLDataDataOneOf, cA as HeadingData, cc as Height, eQ as IdentificationData, eR as IdentificationDataIdOneOf, cq as Image, cD as ImageData, cF as ImageDataStyles, ag as ImagePosition, fU as ImagePositionWithLiterals, dc as ImageStyles, b9 as IncludeMissingValuesOptions, e0 as InfoSection, ab as InitialExpandedItems, fP as InitialExpandedItemsWithLiterals, aW as InternalMetadata, I as InternalRowState, e_ as InternalRowStateWithLiterals, k as Interval, f6 as IntervalWithLiterals, e7 as Inventory, ev as InventoryStatus, cs as Item, ct as ItemDataOneOf, cw as ItemStyle, dM as Keyword, a9 as Layout, dA as LayoutCellData, dy as LayoutData, F as LayoutType, fs as LayoutTypeWithLiterals, fN as LayoutWithLiterals, L as LineStyle, fo as LineStyleWithLiterals, ce as Link, d2 as LinkData, cf as LinkDataOneOf, cG as LinkPreviewData, cH as LinkPreviewDataStyles, ds as ListValue, cI as MapData, cJ as MapSettings, X as MapType, fz as MapTypeWithLiterals, M as MeasurementUnit, eW as MeasurementUnitWithLiterals, dE as Media, dK as MediaItemsInfo, ak as MediaType, fY as MediaTypeWithLiterals, d3 as MentionData, eP as MessageEnvelope, dB as Metadata, b_ as MigrateProductVariantsRequest, eE as MigrateProductVariantsResponse, eD as MinVariantPriceInfo, i as MissingValues, f3 as MissingValuesWithLiterals, l as Mode, f8 as ModeWithLiterals, dY as ModifierChoicesSettings, an as ModifierRenderType, f$ as ModifierRenderTypeWithLiterals, dU as MultipleColors, bh as NestedAggregation, bf as NestedAggregationItem, bg as NestedAggregationItemKindOneOf, bR as NestedAggregationNestedAggregationItem, bS as NestedAggregationNestedAggregationItemKindOneOf, q as NestedAggregationNestedAggregationType, fe as NestedAggregationNestedAggregationTypeWithLiterals, bm as NestedAggregationResults, bn as NestedAggregationResultsResultOneOf, N as NestedAggregationType, f5 as NestedAggregationTypeWithLiterals, bv as NestedResultValue, bw as NestedResultValueResultOneOf, bB as NestedResults, br as NestedValueAggregationResult, c2 as Node, c3 as NodeDataOneOf, c4 as NodeStyle, u as NodeType, fi as NodeTypeWithLiterals, ae as NullValue, fS as NullValueWithLiterals, dj as Oembed, cN as Option, ej as OptionChoice, ek as OptionChoiceIds, el as OptionChoiceNames, cV as OptionDesign, cQ as OptionLayout, du as OrderedListData, O as Orientation, ft as OrientationWithLiterals, cn as PDFSettings, bZ as PagingMetadata, cK as ParagraphData, cM as Permissions, e8 as PhysicalProperties, a6 as Placement, fK as PlacementWithLiterals, bF as PlatformOffsetSearch, bG as PlatformOffsetSearchPagingMethodOneOf, bX as PlatformPaging, dh as PlaybackOptions, c8 as PluginContainerData, w as PluginContainerDataAlignment, fk as PluginContainerDataAlignmentWithLiterals, c9 as PluginContainerDataWidth, ca as PluginContainerDataWidthDataOneOf, cW as Poll, cL as PollData, cX as PollDataLayout, cU as PollDesign, cP as PollLayout, $ as PollLayoutDirection, fD as PollLayoutDirectionWithLiterals, _ as PollLayoutType, fC as PollLayoutTypeWithLiterals, cO as PollSettings, a3 as Position, fH as PositionWithLiterals, ap as PreorderStatus, g1 as PreorderStatusWithLiterals, em as PriceInfo, ep as PricePerUnit, eb as PricePerUnitRange, ec as PricePerUnitRangePricePerUnit, e9 as PricePerUnitSettings, e5 as PriceRange, df as PricingData, b$ as Product, e2 as ProductCategoriesInfo, e3 as ProductCategory, e4 as ProductCategoryIdsInfo, aS as ProductFields, aT as ProductFieldsTypedPropertiesOneOf, dF as ProductMedia, dH as ProductMediaMediaOneOf, P as ProductMediaMediaType, eV as ProductMediaMediaTypeWithLiterals, dG as ProductMediaSetByOneOf, al as ProductOptionRenderType, fZ as ProductOptionRenderTypeWithLiterals, aq as ProductPreorderAvailability, g2 as ProductPreorderAvailabilityWithLiterals, ar as ProductType, g3 as ProductTypeWithLiterals, c0 as ProductTypedPropertiesOneOf, aX as QueryVariantsRequest, b0 as QueryVariantsResponse, bc as RangeAggregation, bK as RangeAggregationRangeBucket, bl as RangeAggregationResult, b8 as RangeBucket, bt as RangeResult, bp as RangeResults, aw as ReadOnlyVariant, eT as ReadOnlyVariantQuerySpec, eU as ReadOnlyVariantSearchSpec, ax as ReadOnlyVariantTypedPropertiesOneOf, eF as RecoverProductVariantsRequest, eG as RecoverProductVariantsResponse, cg as Rel, f as RequestedFields, f0 as RequestedFieldsWithLiterals, a5 as Resizing, fJ as ResizingWithLiterals, ai as ResponsivenessBehaviour, fW as ResponsivenessBehaviourWithLiterals, eK as RestoreInfo, bx as Results, en as RevenueDetails, e1 as Ribbon, dd as RibbonStyles, c1 as RichContent, bd as ScalarAggregation, bu as ScalarResult, j as ScalarType, f4 as ScalarTypeWithLiterals, af as Scaling, fT as ScalingWithLiterals, bi as SearchDetails, s as SearchDetailsMode, fh as SearchDetailsModeWithLiterals, b3 as SearchVariantsRequest, er as SecuredMedia, c as SecuredMediaFileType, eX as SecuredMediaFileTypeWithLiterals, dL as SeoSchema, dO as Settings, h as SortDirection, f2 as SortDirectionWithLiterals, e as SortOrder, e$ as SortOrderWithLiterals, g as SortType, f1 as SortTypeWithLiterals, a_ as Sorting, K as Source, fx as SourceWithLiterals, cb as Spoiler, d5 as SpoilerData, cd as Styles, cE as StylesBorder, U as StylesPosition, fy as StylesPositionWithLiterals, ey as Subscription, ez as SubscriptionCyclesOneOf, ex as SubscriptionDetails, eA as SubscriptionDiscount, eB as SubscriptionDiscountDiscountOneOf, at as SubscriptionFrequency, g5 as SubscriptionFrequencyWithLiterals, et as SubscriptionPrice, eu as SubscriptionPricePerUnit, es as SubscriptionPricesInfo, dn as TableCellData, dl as TableData, dN as Tag, T as Target, fm as TargetWithLiterals, x as TextAlignment, fn as TextAlignmentWithLiterals, cZ as TextData, dD as TextNodeStyle, ci as TextStyle, dJ as Thumbnail, cx as Thumbnails, H as ThumbnailsAlignment, fv as ThumbnailsAlignmentWithLiterals, a7 as Type, fL as TypeWithLiterals, cp as V1Media, aC as V3FixedMonetaryAmount, aR as V3InventoryStatus, ay as V3OptionChoice, az as V3OptionChoiceIds, aA as V3OptionChoiceNames, aU as V3PhysicalProperties, aB as V3PriceInfo, aK as V3PricePerUnit, aL as V3PricePerUnitSettings, aE as V3ProductMedia, aG as V3ProductMediaMediaOneOf, aF as V3ProductMediaSetByOneOf, d as V3ProductType, eY as V3ProductTypeWithLiterals, aD as V3RevenueDetails, aN as V3SecuredMedia, aP as V3SubscriptionPrice, aQ as V3SubscriptionPricePerUnit, aO as V3SubscriptionPricesInfo, aI as V3Thumbnail, aM as V3VariantDigitalProperties, aJ as V3VariantPhysicalProperties, aV as V3WeightMeasurementUnitInfo, ba as ValueAggregation, bL as ValueAggregationIncludeMissingValuesOptions, o as ValueAggregationMissingValues, fc as ValueAggregationMissingValuesWithLiterals, bb as ValueAggregationOptionsOneOf, bk as ValueAggregationResult, n as ValueAggregationSortDirection, fb as ValueAggregationSortDirectionWithLiterals, m as ValueAggregationSortType, fa as ValueAggregationSortTypeWithLiterals, bs as ValueResult, bo as ValueResults, eh as Variant, eq as VariantDigitalProperties, eo as VariantPhysicalProperties, eC as VariantSummary, ei as VariantTypedPropertiesOneOf, eg as VariantsInfo, eS as VariantsQueryResult, ad as VerticalAlignment, ah as VerticalAlignmentAlignment, fV as VerticalAlignmentAlignmentWithLiterals, fR as VerticalAlignmentWithLiterals, cr as Video, dg as VideoData, dI as VideoResolution, E as ViewMode, fr as ViewModeWithLiterals, Y as ViewRole, fA as ViewRoleWithLiterals, Z as VoteRole, fB as VoteRoleWithLiterals, av as WebhookIdentityType, g7 as WebhookIdentityTypeWithLiterals, ed as WeightMeasurementUnitInfo, ea as WeightRange, W as WeightUnit, eZ as WeightUnitWithLiterals, y as Width, v as WidthType, fj as WidthTypeWithLiterals, fp as WidthWithLiterals } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BmO0mCp5.mjs';
 
 declare function searchVariants$1(httpClient: HttpClient): SearchVariantsSignature;
 interface SearchVariantsSignature {
@@ -10,7 +10,12 @@ interface SearchVariantsSignature {
      * Use this endpoint for complex queries that include free-text search, aggregations,
      * or when you need faceted search results. For simple filtering, use Query Variants instead.
      *
-     * Supports Wix Query Language (WQL) for structured filtering combined with free-text search.
+     * To learn about working with _Search_ methods, see
+     * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language)
+     * and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
+     *
+     * Learn more about the differences between [_Query_ and _Search_](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods) methods.
+     *
      * > **Note:** Non-visible variants, and variants related to non-visible products are filtered from results if you don't have permissions to read hidden products.
      * @param - WQL expression for searching variants.
      */