@wix/auto_sdk_stores_read-only-variants-v-3 1.0.44 → 1.0.45
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +8 -3
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +8 -3
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +19 -7
- package/build/cjs/meta.js.map +1 -1
- 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-BNZPBN80.d.ts} +24 -25
- package/build/es/index.d.mts +8 -3
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +8 -3
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +19 -7
- package/build/es/meta.mjs.map +1 -1
- package/build/{internal/es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-11ZHjQPT.d.mts → es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BNZPBN80.d.mts} +24 -25
- package/build/internal/cjs/index.d.ts +8 -3
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +8 -3
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +19 -7
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-D4WyK7_Y.d.ts → internal/cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DIjkz6cb.d.ts} +43 -6
- package/build/internal/es/index.d.mts +8 -3
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +8 -3
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +19 -7
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/{es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-D4WyK7_Y.d.mts → internal/es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DIjkz6cb.d.mts} +43 -6
- package/package.json +2 -2
|
@@ -1826,6 +1826,8 @@ interface Product extends ProductTypedPropertiesOneOf {
|
|
|
1826
1826
|
costRange?: PriceRange;
|
|
1827
1827
|
/**
|
|
1828
1828
|
* Product inventory info.
|
|
1829
|
+
*
|
|
1830
|
+
* > **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.
|
|
1829
1831
|
* @readonly
|
|
1830
1832
|
*/
|
|
1831
1833
|
inventory?: Inventory;
|
|
@@ -1839,18 +1841,13 @@ interface Product extends ProductTypedPropertiesOneOf {
|
|
|
1839
1841
|
/**
|
|
1840
1842
|
* A unique human-friendly identifier for the product.
|
|
1841
1843
|
* Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.
|
|
1842
|
-
*
|
|
1844
|
+
* This is particularly useful when re-importing products from other systems, as it provides a stable identifier.
|
|
1845
|
+
* If no handle is provided, one is automatically generated.
|
|
1843
1846
|
* @minLength 1
|
|
1844
1847
|
* @maxLength 100
|
|
1845
1848
|
* @readonly
|
|
1846
1849
|
*/
|
|
1847
1850
|
handle?: string | null;
|
|
1848
|
-
/**
|
|
1849
|
-
* ID of the last import job that affected the product.
|
|
1850
|
-
* @internal
|
|
1851
|
-
* @format GUID
|
|
1852
|
-
*/
|
|
1853
|
-
importId?: string | null;
|
|
1854
1851
|
/**
|
|
1855
1852
|
* 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.
|
|
1856
1853
|
*
|
|
@@ -1876,12 +1873,6 @@ interface Product extends ProductTypedPropertiesOneOf {
|
|
|
1876
1873
|
* @readonly
|
|
1877
1874
|
*/
|
|
1878
1875
|
compareAtPriceRange?: PriceRange;
|
|
1879
|
-
/**
|
|
1880
|
-
* Optional - ID of the app that manages the inventory for this product.
|
|
1881
|
-
* @internal
|
|
1882
|
-
* @format GUID
|
|
1883
|
-
*/
|
|
1884
|
-
inventoryAppId?: string | null;
|
|
1885
1876
|
/**
|
|
1886
1877
|
* Product variants. Each variant must reference all product options via its `choices` array.
|
|
1887
1878
|
* Each choice references an option using `optionChoiceNames` for all requests.
|
|
@@ -1890,10 +1881,14 @@ interface Product extends ProductTypedPropertiesOneOf {
|
|
|
1890
1881
|
/**
|
|
1891
1882
|
* Custom extended fields for the product object.
|
|
1892
1883
|
*
|
|
1893
|
-
* [Extended fields](https://dev.wix.com/docs/
|
|
1884
|
+
* [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.
|
|
1894
1885
|
*/
|
|
1895
1886
|
extendedFields?: ExtendedFields;
|
|
1896
|
-
/**
|
|
1887
|
+
/**
|
|
1888
|
+
* Product subscriptions.
|
|
1889
|
+
*
|
|
1890
|
+
* 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.
|
|
1891
|
+
*/
|
|
1897
1892
|
subscriptionDetails?: SubscriptionDetails;
|
|
1898
1893
|
/**
|
|
1899
1894
|
* The total number of variants for the product.
|
|
@@ -3795,6 +3790,7 @@ interface TextNodeStyle {
|
|
|
3795
3790
|
interface Media {
|
|
3796
3791
|
/**
|
|
3797
3792
|
* Main media (image, video, etc.) associated with this product.
|
|
3793
|
+
* Automatically set to the first item in the media list.
|
|
3798
3794
|
* @readonly
|
|
3799
3795
|
*/
|
|
3800
3796
|
main?: ProductMedia;
|
|
@@ -4300,7 +4296,7 @@ interface ProductCategory {
|
|
|
4300
4296
|
*/
|
|
4301
4297
|
_id?: string;
|
|
4302
4298
|
/**
|
|
4303
|
-
* 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/
|
|
4299
|
+
* 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/api-reference/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow.
|
|
4304
4300
|
* @max 200
|
|
4305
4301
|
*/
|
|
4306
4302
|
index?: number | null;
|
|
@@ -4549,7 +4545,8 @@ interface Variant extends VariantTypedPropertiesOneOf {
|
|
|
4549
4545
|
/**
|
|
4550
4546
|
* List of choices that define the product's variant, which requires exactly one choice per product option.
|
|
4551
4547
|
* Must use `optionChoiceNames` in all requests this field is required.
|
|
4552
|
-
*
|
|
4548
|
+
*
|
|
4549
|
+
* For products without options (simple products), this array is empty. These products have a single "default variant" that represents the product itself.
|
|
4553
4550
|
* @maxSize 6
|
|
4554
4551
|
* @immutable
|
|
4555
4552
|
*/
|
|
@@ -4685,7 +4682,10 @@ interface PricePerUnit {
|
|
|
4685
4682
|
description?: string | null;
|
|
4686
4683
|
}
|
|
4687
4684
|
interface VariantDigitalProperties {
|
|
4688
|
-
/**
|
|
4685
|
+
/**
|
|
4686
|
+
* Digital file which will be downloaded by the buyer after successful purchase.
|
|
4687
|
+
* Each variant can have a different digital file, allowing you to offer different content per variant.
|
|
4688
|
+
*/
|
|
4689
4689
|
digitalFile?: SecuredMedia;
|
|
4690
4690
|
}
|
|
4691
4691
|
interface SecuredMedia {
|
|
@@ -4803,13 +4803,6 @@ interface SubscriptionDetails {
|
|
|
4803
4803
|
* Default: `false`
|
|
4804
4804
|
*/
|
|
4805
4805
|
allowOneTimePurchases?: boolean | null;
|
|
4806
|
-
/**
|
|
4807
|
-
* 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).
|
|
4808
|
-
*
|
|
4809
|
-
* Default: `false`
|
|
4810
|
-
* @internal
|
|
4811
|
-
*/
|
|
4812
|
-
enableCustomerCancellation?: boolean | null;
|
|
4813
4806
|
}
|
|
4814
4807
|
interface Subscription extends SubscriptionCyclesOneOf {
|
|
4815
4808
|
/** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
|
|
@@ -5120,6 +5113,12 @@ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYM
|
|
|
5120
5113
|
* For complex queries with free-text search and aggregations, use Search Variants instead.
|
|
5121
5114
|
*
|
|
5122
5115
|
* Up to 1,000 variants can be returned per request.
|
|
5116
|
+
*
|
|
5117
|
+
* To learn about working with _Query_ endpoints, see
|
|
5118
|
+
* [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
|
|
5119
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
5120
|
+
*
|
|
5121
|
+
* 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.
|
|
5123
5122
|
* @public
|
|
5124
5123
|
* @permissionId WIX_STORES.READ_ONLY_VARIANT_READ
|
|
5125
5124
|
* @permissionId WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
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-
|
|
3
|
-
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-11ZHjQPT.js';
|
|
2
|
+
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-DIjkz6cb.js';
|
|
3
|
+
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-DIjkz6cb.js';
|
|
4
4
|
|
|
5
5
|
declare function searchVariants$1(httpClient: HttpClient): SearchVariantsSignature;
|
|
6
6
|
interface SearchVariantsSignature {
|
|
@@ -10,7 +10,12 @@ interface SearchVariantsSignature {
|
|
|
10
10
|
* Use this endpoint for complex queries that include free-text search, aggregations,
|
|
11
11
|
* or when you need faceted search results. For simple filtering, use Query Variants instead.
|
|
12
12
|
*
|
|
13
|
-
*
|
|
13
|
+
* To learn about working with _Search_ methods, see
|
|
14
|
+
* [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language)
|
|
15
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
16
|
+
*
|
|
17
|
+
* 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.
|
|
18
|
+
*
|
|
14
19
|
* > **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.
|
|
15
20
|
* @param - WQL expression for searching variants.
|
|
16
21
|
*/
|