@wix/auto_sdk_stores_read-only-variants-v-3 1.0.15 → 1.0.17

package/build/internal/cjs/index.d.ts

@@ -1,35 +1,35 @@
 import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { Q as QueryVariantsOptions, V as VariantsQueryBuilder, R as ReadOnlyVariantSearch, S as SearchVariantsOptions, a as SearchVariantsResponse } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-Ba22Ko-1.js';
-export { eq as ActionEvent, aU as Aggregation, b5 as AggregationData, bC as AggregationDateHistogramAggregation, aV as AggregationKindOneOf, bF as AggregationNestedAggregation, bA as AggregationRangeAggregation, bo as AggregationResults, bp as AggregationResultsResultOneOf, bc as AggregationResultsScalarResult, bB as AggregationScalarAggregation, A as AggregationType, by as AggregationValueAggregation, bz as AggregationValueAggregationOptionsOneOf, y as Alignment, cO as AnchorData, cU as AppEmbedData, cV as AppEmbedDataAppDataOneOf, a1 as AppType, d7 as AudioData, aa as AvailabilityStatus, cE as Background, cF as BackgroundBackgroundOneOf, _ as BackgroundType, da as BlockquoteData, cW as BookingData, bU as Border, d5 as BorderColors, dE as Brand, dU as BreadCrumb, dT as BreadcrumbsInfo, d9 as BulletedListData, bT as ButtonData, db as CaptionData, d4 as CellStyle, a8 as ChoiceType, du as ChoicesSettings, c3 as CodeBlockData, d0 as CollapsibleListData, cP as ColorData, bV as Colors, bu as CommonAggregation, bv as CommonAggregationKindOneOf, q as CommonAggregationType, o as CommonScalarType, bI as CommonSearchDetails, C as CommonSortOrder, bt as CommonSorting, at as CommonVideoResolution, dy as ConnectedModifier, dC as ConnectedModifierChoice, dD as ConnectedModifierChoiceValueOneOf, dz as ConnectedModifierModifierSettingsOneOf, ds as ConnectedOption, dv as ConnectedOptionChoice, dw as ConnectedOptionChoiceValueOneOf, dt as ConnectedOptionOptionSettingsOneOf, E as Crop, aN as CursorPaging, aP as CursorPagingMetadata, aK as CursorQuery, aL as CursorQueryPagingMethodOneOf, aS as CursorSearch, aT as CursorSearchPagingMethodOneOf, aQ as Cursors, b0 as DateHistogramAggregation, D as DateHistogramAggregationInterval, bk as DateHistogramResult, bm as DateHistogramResults, cM as Decoration, cN as DecorationDataOneOf, $ as DecorationType, bq as DeprecatedSearchVariantsWithOffsetRequest, bK as DeprecatedSearchVariantsWithOffsetResponse, cK as Design, d2 as Dimensions, a3 as Direction, ag as DiscountType, c5 as DividerData, de as DocumentStyle, ek as DomainEvent, el as DomainEventBodyOneOf, c_ as EmbedData, er as Empty, em as EntityCreatedEvent, ep as EntityDeletedEvent, eo as EntityUpdatedEvent, cX as EventData, e9 as ExtendedFields, c6 as FileData, c7 as FileSource, c8 as FileSourceDataOneOf, ae as FileType, dL as FixedMonetaryAmount, cS as FontSizeData, a0 as FontType, dA as FreeTextSettings, cl as GIF, ck as GIFData, G as GIFType, ca as GalleryData, cg as GalleryOptions, cD as Gradient, bG as GroupByAggregation, bH as GroupByAggregationKindOneOf, bl as GroupByValueResults, cn as HTMLData, co as HTMLDataDataOneOf, cm as HeadingData, b_ as Height, et as IdentificationData, eu as IdentificationDataIdOneOf, cc as Image, cp as ImageData, cr as ImageDataStyles, aX as IncludeMissingValuesOptions, dF as InfoSection, a2 as InitialExpandedItems, aI as InternalMetadata, I as InternalRowState, j as Interval, dM as Inventory, e8 as InventoryStatus, ce as Item, cf as ItemDataOneOf, ci as ItemStyle, dp as Keyword, ch as Layout, dc as LayoutCellData, B as LayoutType, L as LineStyle, c0 as Link, cQ as LinkData, c1 as LinkDataOneOf, cs as LinkPreviewData, ct as LinkPreviewDataStyles, d6 as ListValue, cu as MapData, cv as MapSettings, K as MapType, M as MeasurementUnit, dg as Media, dm as MediaItemsInfo, a6 as MediaType, cR as MentionData, es as MessageEnvelope, dd as Metadata, bM as MigrateProductVariantsRequest, eh as MigrateProductVariantsResponse, eg as MinVariantPriceInfo, h as MissingValues, k as Mode, dB as ModifierChoicesSettings, a9 as ModifierRenderType, dx as MultipleColors, b3 as NestedAggregation, b1 as NestedAggregationItem, b2 as NestedAggregationItemKindOneOf, bD as NestedAggregationNestedAggregationItem, bE as NestedAggregationNestedAggregationItemKindOneOf, p as NestedAggregationNestedAggregationType, b8 as NestedAggregationResults, b9 as NestedAggregationResultsResultOneOf, N as NestedAggregationType, bh as NestedResultValue, bi as NestedResultValueResultOneOf, bn as NestedResults, bd as NestedValueAggregationResult, bQ as Node, bR as NodeDataOneOf, bS as NodeStyle, s as NodeType, a5 as NullValue, c$ as Oembed, cz as Option, dY as OptionChoice, dZ as OptionChoiceIds, d_ as OptionChoiceNames, cH as OptionDesign, cC as OptionLayout, d8 as OrderedListData, O as Orientation, c9 as PDFSettings, bL as PagingMetadata, cw as ParagraphData, cy as Permissions, dN as PhysicalProperties, br as PlatformOffsetSearch, bs as PlatformOffsetSearchPagingMethodOneOf, bJ as PlatformPaging, cZ as PlaybackOptions, bW as PluginContainerData, u as PluginContainerDataAlignment, bX as PluginContainerDataWidth, bY as PluginContainerDataWidthDataOneOf, cI as Poll, cx as PollData, cJ as PollDataLayout, cG as PollDesign, cB as PollLayout, Z as PollLayoutDirection, Y as PollLayoutType, cA as PollSettings, J as Position, ab as PreorderStatus, d$ as PriceInfo, e2 as PricePerUnit, dQ as PricePerUnitRange, dR as PricePerUnitRangePricePerUnit, dO as PricePerUnitSettings, dK as PriceRange, bN as Product, dH as ProductCategoriesInfo, dI as ProductCategory, dJ as ProductCategoryIdsInfo, aE as ProductFields, aF as ProductFieldsTypedPropertiesOneOf, dh as ProductMedia, dj as ProductMediaMediaOneOf, P as ProductMediaMediaType, di as ProductMediaSetByOneOf, a7 as ProductOptionRenderType, ac as ProductPreorderAvailability, ad as ProductType, bO as ProductTypedPropertiesOneOf, aJ as QueryVariantsRequest, aO as QueryVariantsResponse, a_ as RangeAggregation, bw as RangeAggregationRangeBucket, b7 as RangeAggregationResult, aW as RangeBucket, bf as RangeResult, bb as RangeResults, ai as ReadOnlyVariant, ew as ReadOnlyVariantSearchSpec, aj as ReadOnlyVariantTypedPropertiesOneOf, ei as RecoverProductVariantsRequest, ej as RecoverProductVariantsResponse, c2 as Rel, e as RequestedFields, en as RestoreInfo, bj as Results, e0 as RevenueDetails, dG as Ribbon, bP as RichContent, a$ as ScalarAggregation, bg as ScalarResult, i as ScalarType, b4 as SearchDetails, r as SearchDetailsMode, aR as SearchVariantsRequest, e4 as SecuredMedia, b as SecuredMediaFileType, dn as SeoSchema, dr as Settings, g as SortDirection, d as SortOrder, f as SortType, aM as Sorting, H as Source, bZ as Spoiler, cT as SpoilerData, b$ as Styles, cq as StylesBorder, eb as Subscription, ec as SubscriptionCyclesOneOf, ea as SubscriptionDetails, ed as SubscriptionDiscount, ee as SubscriptionDiscountDiscountOneOf, af as SubscriptionFrequency, e6 as SubscriptionPrice, e7 as SubscriptionPricePerUnit, e5 as SubscriptionPricesInfo, d3 as TableCellData, d1 as TableData, dq as Tag, v as Target, w as TextAlignment, cL as TextData, df as TextNodeStyle, c4 as TextStyle, dl as Thumbnail, cj as Thumbnails, F as ThumbnailsAlignment, T as Type, cb as V1Media, ao as V3FixedMonetaryAmount, aD as V3InventoryStatus, ak as V3OptionChoice, al as V3OptionChoiceIds, am as V3OptionChoiceNames, aG as V3PhysicalProperties, an as V3PriceInfo, aw as V3PricePerUnit, ax as V3PricePerUnitSettings, aq as V3ProductMedia, as as V3ProductMediaMediaOneOf, ar as V3ProductMediaSetByOneOf, c as V3ProductType, ap as V3RevenueDetails, az as V3SecuredMedia, aB as V3SubscriptionPrice, aC as V3SubscriptionPricePerUnit, aA as V3SubscriptionPricesInfo, au as V3Thumbnail, ay as V3VariantDigitalProperties, av as V3VariantPhysicalProperties, aH as V3WeightMeasurementUnitInfo, aY as ValueAggregation, bx as ValueAggregationIncludeMissingValuesOptions, n as ValueAggregationMissingValues, aZ as ValueAggregationOptionsOneOf, b6 as ValueAggregationResult, m as ValueAggregationSortDirection, l as ValueAggregationSortType, be as ValueResult, ba as ValueResults, dW as Variant, e3 as VariantDigitalProperties, e1 as VariantPhysicalProperties, ef as VariantSummary, dX as VariantTypedPropertiesOneOf, dV as VariantsInfo, ev as VariantsQueryResult, a4 as VerticalAlignment, cd as Video, cY as VideoData, dk as VideoResolution, z as ViewMode, U as ViewRole, X as VoteRole, ah as WebhookIdentityType, dS as WeightMeasurementUnitInfo, dP as WeightRange, W as WeightUnit, x as Width, t as WidthType } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-Ba22Ko-1.js';
+import { Q as QueryVariantsOptions, V as VariantsQueryBuilder, R as ReadOnlyVariantSearch, S as SearchVariantsOptions, a as SearchVariantsResponse } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DwK-NZst.js';
+export { eq as ActionEvent, aU as Aggregation, b5 as AggregationData, bC as AggregationDateHistogramAggregation, aV as AggregationKindOneOf, bF as AggregationNestedAggregation, bA as AggregationRangeAggregation, bo as AggregationResults, bp as AggregationResultsResultOneOf, bc as AggregationResultsScalarResult, bB as AggregationScalarAggregation, A as AggregationType, by as AggregationValueAggregation, bz as AggregationValueAggregationOptionsOneOf, y as Alignment, cO as AnchorData, cU as AppEmbedData, cV as AppEmbedDataAppDataOneOf, a1 as AppType, d7 as AudioData, aa as AvailabilityStatus, cE as Background, cF as BackgroundBackgroundOneOf, _ as BackgroundType, da as BlockquoteData, cW as BookingData, bU as Border, d5 as BorderColors, dE as Brand, dU as BreadCrumb, dT as BreadcrumbsInfo, d9 as BulletedListData, bT as ButtonData, db as CaptionData, d4 as CellStyle, a8 as ChoiceType, du as ChoicesSettings, c3 as CodeBlockData, d0 as CollapsibleListData, cP as ColorData, bV as Colors, bu as CommonAggregation, bv as CommonAggregationKindOneOf, q as CommonAggregationType, o as CommonScalarType, bI as CommonSearchDetails, C as CommonSortOrder, bt as CommonSorting, at as CommonVideoResolution, dy as ConnectedModifier, dC as ConnectedModifierChoice, dD as ConnectedModifierChoiceValueOneOf, dz as ConnectedModifierModifierSettingsOneOf, ds as ConnectedOption, dv as ConnectedOptionChoice, dw as ConnectedOptionChoiceValueOneOf, dt as ConnectedOptionOptionSettingsOneOf, E as Crop, aN as CursorPaging, aP as CursorPagingMetadata, aK as CursorQuery, aL as CursorQueryPagingMethodOneOf, aS as CursorSearch, aT as CursorSearchPagingMethodOneOf, aQ as Cursors, b0 as DateHistogramAggregation, D as DateHistogramAggregationInterval, bk as DateHistogramResult, bm as DateHistogramResults, cM as Decoration, cN as DecorationDataOneOf, $ as DecorationType, bq as DeprecatedSearchVariantsWithOffsetRequest, bK as DeprecatedSearchVariantsWithOffsetResponse, cK as Design, d2 as Dimensions, a3 as Direction, ag as DiscountType, c5 as DividerData, de as DocumentStyle, ek as DomainEvent, el as DomainEventBodyOneOf, c_ as EmbedData, er as Empty, em as EntityCreatedEvent, ep as EntityDeletedEvent, eo as EntityUpdatedEvent, cX as EventData, e9 as ExtendedFields, c6 as FileData, c7 as FileSource, c8 as FileSourceDataOneOf, ae as FileType, dL as FixedMonetaryAmount, cS as FontSizeData, a0 as FontType, dA as FreeTextSettings, cl as GIF, ck as GIFData, G as GIFType, ca as GalleryData, cg as GalleryOptions, cD as Gradient, bG as GroupByAggregation, bH as GroupByAggregationKindOneOf, bl as GroupByValueResults, cn as HTMLData, co as HTMLDataDataOneOf, cm as HeadingData, b_ as Height, et as IdentificationData, eu as IdentificationDataIdOneOf, cc as Image, cp as ImageData, cr as ImageDataStyles, aX as IncludeMissingValuesOptions, dF as InfoSection, a2 as InitialExpandedItems, aI as InternalMetadata, I as InternalRowState, j as Interval, dM as Inventory, e8 as InventoryStatus, ce as Item, cf as ItemDataOneOf, ci as ItemStyle, dp as Keyword, ch as Layout, dc as LayoutCellData, B as LayoutType, L as LineStyle, c0 as Link, cQ as LinkData, c1 as LinkDataOneOf, cs as LinkPreviewData, ct as LinkPreviewDataStyles, d6 as ListValue, cu as MapData, cv as MapSettings, K as MapType, M as MeasurementUnit, dg as Media, dm as MediaItemsInfo, a6 as MediaType, cR as MentionData, es as MessageEnvelope, dd as Metadata, bM as MigrateProductVariantsRequest, eh as MigrateProductVariantsResponse, eg as MinVariantPriceInfo, h as MissingValues, k as Mode, dB as ModifierChoicesSettings, a9 as ModifierRenderType, dx as MultipleColors, b3 as NestedAggregation, b1 as NestedAggregationItem, b2 as NestedAggregationItemKindOneOf, bD as NestedAggregationNestedAggregationItem, bE as NestedAggregationNestedAggregationItemKindOneOf, p as NestedAggregationNestedAggregationType, b8 as NestedAggregationResults, b9 as NestedAggregationResultsResultOneOf, N as NestedAggregationType, bh as NestedResultValue, bi as NestedResultValueResultOneOf, bn as NestedResults, bd as NestedValueAggregationResult, bQ as Node, bR as NodeDataOneOf, bS as NodeStyle, s as NodeType, a5 as NullValue, c$ as Oembed, cz as Option, dY as OptionChoice, dZ as OptionChoiceIds, d_ as OptionChoiceNames, cH as OptionDesign, cC as OptionLayout, d8 as OrderedListData, O as Orientation, c9 as PDFSettings, bL as PagingMetadata, cw as ParagraphData, cy as Permissions, dN as PhysicalProperties, br as PlatformOffsetSearch, bs as PlatformOffsetSearchPagingMethodOneOf, bJ as PlatformPaging, cZ as PlaybackOptions, bW as PluginContainerData, u as PluginContainerDataAlignment, bX as PluginContainerDataWidth, bY as PluginContainerDataWidthDataOneOf, cI as Poll, cx as PollData, cJ as PollDataLayout, cG as PollDesign, cB as PollLayout, Z as PollLayoutDirection, Y as PollLayoutType, cA as PollSettings, J as Position, ab as PreorderStatus, d$ as PriceInfo, e2 as PricePerUnit, dQ as PricePerUnitRange, dR as PricePerUnitRangePricePerUnit, dO as PricePerUnitSettings, dK as PriceRange, bN as Product, dH as ProductCategoriesInfo, dI as ProductCategory, dJ as ProductCategoryIdsInfo, aE as ProductFields, aF as ProductFieldsTypedPropertiesOneOf, dh as ProductMedia, dj as ProductMediaMediaOneOf, P as ProductMediaMediaType, di as ProductMediaSetByOneOf, a7 as ProductOptionRenderType, ac as ProductPreorderAvailability, ad as ProductType, bO as ProductTypedPropertiesOneOf, aJ as QueryVariantsRequest, aO as QueryVariantsResponse, a_ as RangeAggregation, bw as RangeAggregationRangeBucket, b7 as RangeAggregationResult, aW as RangeBucket, bf as RangeResult, bb as RangeResults, ai as ReadOnlyVariant, ew as ReadOnlyVariantSearchSpec, aj as ReadOnlyVariantTypedPropertiesOneOf, ei as RecoverProductVariantsRequest, ej as RecoverProductVariantsResponse, c2 as Rel, e as RequestedFields, en as RestoreInfo, bj as Results, e0 as RevenueDetails, dG as Ribbon, bP as RichContent, a$ as ScalarAggregation, bg as ScalarResult, i as ScalarType, b4 as SearchDetails, r as SearchDetailsMode, aR as SearchVariantsRequest, e4 as SecuredMedia, b as SecuredMediaFileType, dn as SeoSchema, dr as Settings, g as SortDirection, d as SortOrder, f as SortType, aM as Sorting, H as Source, bZ as Spoiler, cT as SpoilerData, b$ as Styles, cq as StylesBorder, eb as Subscription, ec as SubscriptionCyclesOneOf, ea as SubscriptionDetails, ed as SubscriptionDiscount, ee as SubscriptionDiscountDiscountOneOf, af as SubscriptionFrequency, e6 as SubscriptionPrice, e7 as SubscriptionPricePerUnit, e5 as SubscriptionPricesInfo, d3 as TableCellData, d1 as TableData, dq as Tag, v as Target, w as TextAlignment, cL as TextData, df as TextNodeStyle, c4 as TextStyle, dl as Thumbnail, cj as Thumbnails, F as ThumbnailsAlignment, T as Type, cb as V1Media, ao as V3FixedMonetaryAmount, aD as V3InventoryStatus, ak as V3OptionChoice, al as V3OptionChoiceIds, am as V3OptionChoiceNames, aG as V3PhysicalProperties, an as V3PriceInfo, aw as V3PricePerUnit, ax as V3PricePerUnitSettings, aq as V3ProductMedia, as as V3ProductMediaMediaOneOf, ar as V3ProductMediaSetByOneOf, c as V3ProductType, ap as V3RevenueDetails, az as V3SecuredMedia, aB as V3SubscriptionPrice, aC as V3SubscriptionPricePerUnit, aA as V3SubscriptionPricesInfo, au as V3Thumbnail, ay as V3VariantDigitalProperties, av as V3VariantPhysicalProperties, aH as V3WeightMeasurementUnitInfo, aY as ValueAggregation, bx as ValueAggregationIncludeMissingValuesOptions, n as ValueAggregationMissingValues, aZ as ValueAggregationOptionsOneOf, b6 as ValueAggregationResult, m as ValueAggregationSortDirection, l as ValueAggregationSortType, be as ValueResult, ba as ValueResults, dW as Variant, e3 as VariantDigitalProperties, e1 as VariantPhysicalProperties, ef as VariantSummary, dX as VariantTypedPropertiesOneOf, dV as VariantsInfo, ev as VariantsQueryResult, a4 as VerticalAlignment, cd as Video, cY as VideoData, dk as VideoResolution, z as ViewMode, U as ViewRole, X as VoteRole, ah as WebhookIdentityType, dS as WeightMeasurementUnitInfo, dP as WeightRange, W as WeightUnit, x as Width, t as WidthType } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DwK-NZst.js';
 
-/** @internal */
 declare function queryVariants$1(httpClient: HttpClient): QueryVariantsSignature;
 interface QueryVariantsSignature {
     /**
-     * Retrieves a list of ReadOnlyVariants, given the provided [paging, filtering, and sorting][1].
-     * Up to 1,000 ReadOnlyVariants can be returned per request.
-     * To learn how to query ReadOnlyVariants, see [API Query Language][2].
-     * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
-     * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
+     * Retrieve product variants using structured queries with cursor-based pagination.
+     *
+     * Use this endpoint for simple filtering operations on `id` and `productId`.
+     * For complex queries with free-text search and aggregations, use Search Variants instead.
+     *
+     * Up to 1,000 variants can be returned per request.
      */
     (options?: QueryVariantsOptions | undefined): VariantsQueryBuilder;
 }
-/** @internal */
 declare function searchVariants$1(httpClient: HttpClient): SearchVariantsSignature;
 interface SearchVariantsSignature {
     /**
-     * Search Variants using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
-     * >**Notes:**
-     * + If you don't have permissions to read non visible products then variants related to non-visible products will be filtered out from response.
-     * In such case non visible variants also will be filtered out.
-     * @param - WQL expression
+     * Search product variants using free-text search with advanced query capabilities.
+     *
+     * 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.
+     * > **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.
      */
     (search: ReadOnlyVariantSearch, options?: SearchVariantsOptions | undefined): Promise<SearchVariantsResponse>;
 }
 
-/** @internal */
 declare const queryVariants: MaybeContext<BuildRESTFunction<typeof queryVariants$1> & typeof queryVariants$1>;
-/** @internal */
 declare const searchVariants: MaybeContext<BuildRESTFunction<typeof searchVariants$1> & typeof searchVariants$1>;
 
 export { QueryVariantsOptions, SearchVariantsOptions, SearchVariantsResponse, VariantsQueryBuilder, queryVariants, searchVariants };