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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/build/cjs/index.d.ts +23 -4727
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +27 -0
  4. package/build/cjs/index.typings.js +913 -0
  5. package/build/cjs/index.typings.js.map +1 -0
  6. package/build/cjs/meta.d.ts +187 -81
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/{internal/cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-Ba22Ko-1.d.ts → cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BvjIOy5Y.d.ts} +221 -98
  9. package/build/es/index.d.mts +23 -4727
  10. package/build/es/index.mjs.map +1 -1
  11. package/build/es/index.typings.d.mts +27 -0
  12. package/build/es/index.typings.mjs +821 -0
  13. package/build/es/index.typings.mjs.map +1 -0
  14. package/build/es/meta.d.mts +187 -81
  15. package/build/es/meta.mjs.map +1 -1
  16. package/build/{internal/es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-Ba22Ko-1.d.mts → es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BvjIOy5Y.d.mts} +221 -98
  17. package/build/internal/cjs/index.d.ts +16 -16
  18. package/build/internal/cjs/index.js.map +1 -1
  19. package/build/internal/cjs/index.typings.d.ts +27 -0
  20. package/build/internal/cjs/index.typings.js +913 -0
  21. package/build/internal/cjs/index.typings.js.map +1 -0
  22. package/build/internal/cjs/meta.d.ts +187 -81
  23. package/build/internal/cjs/meta.js.map +1 -1
  24. package/build/internal/cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DwK-NZst.d.ts +4990 -0
  25. package/build/internal/es/index.d.mts +16 -16
  26. package/build/internal/es/index.mjs.map +1 -1
  27. package/build/internal/es/index.typings.d.mts +27 -0
  28. package/build/internal/es/index.typings.mjs +821 -0
  29. package/build/internal/es/index.typings.mjs.map +1 -0
  30. package/build/internal/es/meta.d.mts +187 -81
  31. package/build/internal/es/meta.mjs.map +1 -1
  32. package/build/internal/es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DwK-NZst.d.mts +4990 -0
  33. package/package.json +2 -2
@@ -1,9 +1,27 @@
1
1
  import { SearchSpec, Search } from '@wix/sdk-types';
2
2
 
3
+ /**
4
+ * A read-only representation of a product variant with enhanced query capabilities.
5
+ *
6
+ * Product variants represent different options of a product, such as size, color, or material combinations.
7
+ * This read-only variant provides direct access to variant data without requiring nested product queries,
8
+ * making it ideal for inventory management, variant comparison, and e-commerce catalog displays.
9
+ *
10
+ * The variant includes both variant-specific information (like SKU, price, and option choices), as well as
11
+ * contextual product information (like product name, visibility, categories) for convenience.
12
+ */
3
13
  interface ReadOnlyVariant extends ReadOnlyVariantTypedPropertiesOneOf {
4
- /** Physical properties. Must be passed when `productType: PHYSICAL` */
14
+ /**
15
+ * Physical properties such as weight and dimensions.
16
+ *
17
+ * Required when the product type is `PHYSICAL`.
18
+ */
5
19
  physicalProperties?: V3VariantPhysicalProperties;
6
- /** Digital properties. Must be passed when `productType: DIGITAL` */
20
+ /**
21
+ * Digital properties such as downloadable files.
22
+ *
23
+ * Required when the product type is `DIGITAL`.
24
+ */
7
25
  digitalProperties?: V3VariantDigitalProperties;
8
26
  /**
9
27
  * Variant ID.
@@ -19,91 +37,113 @@ interface ReadOnlyVariant extends ReadOnlyVariantTypedPropertiesOneOf {
19
37
  */
20
38
  visible?: boolean | null;
21
39
  /**
22
- * Variant SKU (stock keeping unit).
40
+ * Stock keeping unit (SKU) for inventory tracking and identification.
41
+ *
42
+ * The SKU is typically used for inventory management, order fulfillment, and product identification
43
+ * across different systems.
23
44
  * @minLength 1
24
45
  * @maxLength 40
25
46
  * @readonly
26
47
  */
27
48
  sku?: string | null;
28
49
  /**
29
- * Variant barcode.
50
+ * Barcode for the variant, typically used for point-of-sale systems and inventory management.
51
+ *
52
+ * Common barcode formats include UPC, EAN, and Code 128. The barcode helps with
53
+ * quick product identification and checkout processes.
30
54
  * @minLength 1
31
55
  * @maxLength 40
32
56
  * @readonly
33
57
  */
34
58
  barcode?: string | null;
35
59
  /**
36
- * List of option choices
37
- * In case this list is empty, this is the default variant of an unmanaged product. - check if bridges need more than ids
60
+ * Product option choices that define this variant.
61
+ *
62
+ * Each option choice represents a specific selection for a product option (like "Size: Large" or "Color: Red").
63
+ * An empty list indicates this is the default variant of a product with no managed options.
38
64
  * @maxSize 6
39
65
  * @readonly
40
66
  */
41
67
  optionChoices?: V3OptionChoice[];
42
68
  /**
43
- * Variant price.
69
+ * Pricing information for the variant.
44
70
  * @readonly
45
71
  */
46
72
  price?: V3PriceInfo;
47
73
  /**
48
- * Variant revenue details.
74
+ * Revenue and cost details for business analytics.
49
75
  *
50
- * > **Note:** Returned only when the following conditions are met:
51
- * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
52
- * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
76
+ * Includes cost, profit, and profit margin calculations.
77
+ * Returned only when you pass `"MERCHANT_DATA"` to the `fields` parameter.
53
78
  * @readonly
54
79
  */
55
80
  revenueDetails?: V3RevenueDetails;
56
81
  /**
57
- * Variant media.
82
+ * Media associated with the variant.
83
+ *
84
+ * Typically includes images, videos, or other media files specific to this variant.
58
85
  * @readonly
59
86
  */
60
87
  media?: V3ProductMedia;
61
88
  /**
62
- * Subscription prices calculated by applying subscription discount to the variant `price.actualPrice`.
63
- * > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
89
+ * Subscription pricing information when the variant is part of subscription plans.
90
+ *
91
+ * Shows calculated prices after applying subscription discounts to the variant's price.
92
+ * Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` parameter.
64
93
  * @readonly
65
94
  */
66
95
  subscriptionPricesInfo?: V3SubscriptionPricesInfo;
67
96
  /**
68
- * Variant inventory status.
97
+ * Current inventory and availability status.
69
98
  * @readonly
70
99
  */
71
100
  inventoryStatus?: V3InventoryStatus;
72
101
  /**
73
- * Product fields
102
+ * Product information for context and convenience.
103
+ *
104
+ * Includes essential product details like name, visibility, and categories to avoid
105
+ * requiring separate product API calls when working with variants.
74
106
  * @readonly
75
107
  */
76
108
  productData?: ProductFields;
77
109
  }
78
110
  /** @oneof */
79
111
  interface ReadOnlyVariantTypedPropertiesOneOf {
80
- /** Physical properties. Must be passed when `productType: PHYSICAL` */
112
+ /**
113
+ * Physical properties such as weight and dimensions.
114
+ *
115
+ * Required when the product type is `PHYSICAL`.
116
+ */
81
117
  physicalProperties?: V3VariantPhysicalProperties;
82
- /** Digital properties. Must be passed when `productType: DIGITAL` */
118
+ /**
119
+ * Digital properties such as downloadable files.
120
+ *
121
+ * Required when the product type is `DIGITAL`.
122
+ */
83
123
  digitalProperties?: V3VariantDigitalProperties;
84
124
  }
85
125
  interface V3OptionChoice {
86
126
  /**
87
- * Option and choice IDs.
127
+ * Option and choice identifiers.
88
128
  * @readonly
89
129
  */
90
130
  optionChoiceIds?: V3OptionChoiceIds;
91
131
  /**
92
- * Option and choice names.
132
+ * Human-readable option and choice names.
93
133
  * @readonly
94
134
  */
95
135
  optionChoiceNames?: V3OptionChoiceNames;
96
136
  }
97
137
  interface V3OptionChoiceIds {
98
138
  /**
99
- * Option ID.
139
+ * Product option ID.
100
140
  * @minLength 1
101
141
  * @maxLength 36
102
142
  * @readonly
103
143
  */
104
144
  optionId?: string;
105
145
  /**
106
- * Choice ID.
146
+ * Specific choice ID within the option.
107
147
  * @format GUID
108
148
  * @readonly
109
149
  */
@@ -111,21 +151,28 @@ interface V3OptionChoiceIds {
111
151
  }
112
152
  interface V3OptionChoiceNames {
113
153
  /**
114
- * Option name.
154
+ * Display name of the product option.
155
+ *
156
+ * For example, "Size", "Color", or "Material".
115
157
  * @minLength 1
116
158
  * @maxLength 50
117
159
  * @readonly
118
160
  */
119
161
  optionName?: string;
120
162
  /**
121
- * Choice name.
163
+ * Display name of the chosen option value.
164
+ *
165
+ * For example, "Large", "Red", or "Cotton".
122
166
  * @minLength 1
123
167
  * @maxLength 50
124
168
  * @readonly
125
169
  */
126
170
  choiceName?: string;
127
171
  /**
128
- * Render type.
172
+ * Visual representation style for the option choice.
173
+ *
174
+ * Determines how the option is displayed in the product selector UI.
175
+ * Common values include "TEXT_CHOICES", "COLOR_CHOICES", or "IMAGE_CHOICES".
129
176
  * @readonly
130
177
  * @maxLength 50
131
178
  */
@@ -133,12 +180,15 @@ interface V3OptionChoiceNames {
133
180
  }
134
181
  interface V3PriceInfo {
135
182
  /**
136
- * Variant price.
183
+ * Current selling price of the variant.
137
184
  * @readonly
138
185
  */
139
186
  actualPrice?: V3FixedMonetaryAmount;
140
187
  /**
141
- * The compare-at-price represents the original price of a product before any discount.
188
+ * Original price before any discounts.
189
+ *
190
+ * Used to show customers the savings when the variant is on sale.
191
+ * If not set, no original price is displayed.
142
192
  * @readonly
143
193
  */
144
194
  compareAtPrice?: V3FixedMonetaryAmount;
@@ -159,18 +209,22 @@ interface V3FixedMonetaryAmount {
159
209
  }
160
210
  interface V3RevenueDetails {
161
211
  /**
162
- * Item cost.
212
+ * Cost of the variant for profit calculations.
213
+ *
214
+ * The amount you pay to produce or acquire this variant.
163
215
  * @readonly
164
216
  */
165
217
  cost?: V3FixedMonetaryAmount;
166
218
  /**
167
- * Profit. Calculated by reducing `cost` from `discountedPrice`.
219
+ * Profit amount calculated by subtracting cost from the discounted price.
168
220
  * @readonly
169
221
  */
170
222
  profit?: V3FixedMonetaryAmount;
171
223
  /**
172
- * Profit Margin. Calculated by dividing `profit` by `discountedPrice`.
173
- * The result is rounded to 4 decimal places.
224
+ * Profit margin as a percentage of the selling price.
225
+ *
226
+ * Calculated by dividing profit by the discounted price. The result is rounded to 4 decimal places.
227
+ * A value of 0.25 represents a 25% profit margin.
174
228
  * @readonly
175
229
  * @max 1
176
230
  */
@@ -287,7 +341,7 @@ declare enum ProductMediaMediaType {
287
341
  type ProductMediaMediaTypeWithLiterals = ProductMediaMediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
288
342
  interface V3Thumbnail {
289
343
  /**
290
- * Thumbnail url.
344
+ * Thumbnail URL.
291
345
  * @format WEB_URL
292
346
  * @readonly
293
347
  */
@@ -312,35 +366,45 @@ interface V3Thumbnail {
312
366
  }
313
367
  interface V3VariantPhysicalProperties {
314
368
  /**
315
- * Variant shipping weight.
369
+ * Weight of the variant for shipping calculations.
370
+ *
371
+ * Used for shipping cost calculations and fulfillment planning.
372
+ * Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` parameter.
316
373
  * @max 999999999.99
317
374
  * @readonly
318
375
  */
319
376
  weight?: number | null;
320
377
  /**
321
- * Price per unit info, in order to show price per unit on the product page.
322
- * For example if one sells cheese and defines 100g here then we know that buying this variant buyer receives 100g of cheese.
323
- * But on product page price will be displayed for units defined on product level. See `pricePerUnit.value` to understand how it's calculated.
378
+ * Price per unit measurement information.
379
+ *
380
+ * Allows customers to compare prices based on a standard unit (like price per kilogram or per liter).
381
+ * Useful for bulk products or items sold by weight or volume.
324
382
  * @readonly
325
383
  */
326
384
  pricePerUnit?: V3PricePerUnit;
327
385
  }
328
386
  interface V3PricePerUnit {
329
387
  /**
330
- * Price per unit data for this variant.
331
- * `measurementUnit` value must correspond to the measurement unit set on the product.
388
+ * Price per unit measurement settings.
389
+ *
390
+ * Defines the unit of measurement for price comparison (e.g., per kilogram, per liter).
391
+ * The measurement unit must correspond to the unit set on the parent product.
332
392
  * @readonly
333
393
  */
334
394
  settings?: V3PricePerUnitSettings;
335
395
  /**
336
- * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.
337
- * For example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$ (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).
396
+ * Calculated price per unit value.
397
+ *
398
+ * Shows the variant's price normalized to the standard unit of measurement.
399
+ * For example, if a 500g variant costs $2 and the standard unit is 1kg, this value would be $4.
338
400
  * @readonly
339
401
  * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
340
402
  */
341
403
  value?: string;
342
404
  /**
343
- * Price per unit description.
405
+ * Human-readable description of the price per unit.
406
+ *
407
+ * For example, "per kg" or "per liter".
344
408
  * @readonly
345
409
  * @maxLength 100
346
410
  */
@@ -390,7 +454,9 @@ declare enum MeasurementUnit {
390
454
  type MeasurementUnitWithLiterals = MeasurementUnit | 'UNSPECIFIED' | 'ML' | 'CL' | 'L' | 'CBM' | 'MG' | 'G' | 'KG' | 'MM' | 'CM' | 'M' | 'SQM' | 'OZ' | 'LB' | 'FLOZ' | 'PT' | 'QT' | 'GAL' | 'IN' | 'FT' | 'YD' | 'SQFT';
391
455
  interface V3VariantDigitalProperties {
392
456
  /**
393
- * Digital file which will be downloaded by customer after successful purchase.
457
+ * Digital file available for download after purchase.
458
+ *
459
+ * The file that customers receive when they purchase this digital variant.
394
460
  * @readonly
395
461
  */
396
462
  digitalFile?: V3SecuredMedia;
@@ -443,7 +509,9 @@ declare enum SecuredMediaFileType {
443
509
  type SecuredMediaFileTypeWithLiterals = SecuredMediaFileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
444
510
  interface V3SubscriptionPricesInfo {
445
511
  /**
446
- * Subscription prices.
512
+ * Pricing for different subscription plans.
513
+ *
514
+ * Shows how the variant's price changes with different subscription intervals or discounts.
447
515
  * @maxSize 6
448
516
  * @readonly
449
517
  */
@@ -451,31 +519,33 @@ interface V3SubscriptionPricesInfo {
451
519
  }
452
520
  interface V3SubscriptionPrice {
453
521
  /**
454
- * Subscription ID.
522
+ * Subscription plan ID.
455
523
  * @format GUID
456
524
  * @readonly
457
525
  */
458
526
  subscriptionId?: string;
459
527
  /**
460
- * Subscription price calculated by applying subscription discount to the variant `price.salePrice`
528
+ * Variant price with subscription discount applied.
461
529
  * @readonly
462
530
  */
463
531
  price?: V3FixedMonetaryAmount;
464
532
  /**
465
- * Price per unit info.
533
+ * Price per unit for subscription pricing.
466
534
  * @readonly
467
535
  */
468
536
  pricePerUnit?: V3SubscriptionPricePerUnit;
469
537
  }
470
538
  interface V3SubscriptionPricePerUnit {
471
539
  /**
472
- * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
540
+ * Calculated price per unit for the subscription.
541
+ *
542
+ * Takes into account the subscription discount and the variant's price per unit settings.
473
543
  * @readonly
474
544
  * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
475
545
  */
476
546
  value?: string;
477
547
  /**
478
- * Price per unit description.
548
+ * Description of the subscription price per unit.
479
549
  * @readonly
480
550
  * @maxLength 20
481
551
  */
@@ -483,80 +553,87 @@ interface V3SubscriptionPricePerUnit {
483
553
  }
484
554
  interface V3InventoryStatus {
485
555
  /**
486
- * Whether the variant is in stock.
556
+ * Whether the variant is currently in stock and available for purchase.
487
557
  * @readonly
488
558
  */
489
559
  inStock?: boolean;
490
560
  /**
491
- * Whether preorder is enabled for this variant.
561
+ * Whether customers can place preorders for this variant when it's out of stock.
492
562
  * @readonly
493
563
  */
494
564
  preorderEnabled?: boolean;
495
565
  }
496
566
  interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
497
567
  /**
498
- * Physical properties.
568
+ * Physical product properties such as weight and dimensions.
499
569
  *
500
- * Required when `productType: PHYSICAL`.
570
+ * Required when `productType` is `PHYSICAL`.
501
571
  */
502
572
  physicalProperties?: V3PhysicalProperties;
503
573
  /**
504
- * product id
574
+ * Product ID.
505
575
  * @minLength 1
506
576
  * @maxLength 36
507
577
  * @readonly
508
578
  */
509
579
  productId?: string;
510
580
  /**
511
- * Product name.
581
+ * Product name displayed to customers.
512
582
  * @minLength 1
513
583
  * @maxLength 80
514
584
  * @readonly
515
585
  */
516
586
  name?: string | null;
517
587
  /**
518
- * product type
588
+ * Type of product determining available properties and behavior.
519
589
  * @readonly
520
590
  */
521
591
  productType?: V3ProductTypeWithLiterals;
522
592
  /**
523
- * Product slug.
593
+ * URL-friendly identifier for the product.
594
+ *
595
+ * Used in product page URLs and for SEO optimization.
524
596
  * @format URL_SLUG
525
597
  * @readonly
526
598
  */
527
599
  slug?: string | null;
528
600
  /**
529
- * Whether the product is visible to site visitors on the site.
601
+ * Whether the product is visible to site visitors.
530
602
  *
531
603
  * Default: `true`
532
604
  * @readonly
533
605
  */
534
606
  visible?: boolean | null;
535
607
  /**
536
- * Whether the product is visible in POS (point of sale).
608
+ * Whether the product appears in point-of-sale systems.
537
609
  *
538
610
  * Default: `true`
539
- * > **Note:** Always `false` for `productType: DIGITAL`.
611
+ * Always `false` for digital products.
540
612
  * @readonly
541
613
  */
542
614
  visibleInPos?: boolean | null;
543
615
  /**
544
- * Main category ID.
616
+ * Primary category assignment for the product.
617
+ *
618
+ * Determines the main category used for navigation and organization.
545
619
  * @format GUID
546
620
  * @readonly
547
621
  */
548
622
  mainCategoryId?: string | null;
549
623
  /**
550
- * 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.
624
+ * Currency used for pricing this product.
551
625
  *
552
- * Defaults to the currency defined in the site settings, unless specified in `x-wix-currency` header.
553
- * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
626
+ * Three-letter currency code in ISO-4217 alphabetic format.
627
+ * Defaults to the site's currency setting unless specified in request headers.
628
+ * Returned only when you pass `"CURRENCY"` to the `fields` parameter.
554
629
  * @format CURRENCY
555
630
  * @readonly
556
631
  */
557
632
  currency?: string | null;
558
633
  /**
559
- * Product entity revision.
634
+ * Revision number, which increments by 1 each time the product is updated.
635
+ * To prevent conflicting changes,
636
+ * the current revision must be passed when updating the product.
560
637
  * @readonly
561
638
  */
562
639
  revision?: string | null;
@@ -564,9 +641,9 @@ interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
564
641
  /** @oneof */
565
642
  interface ProductFieldsTypedPropertiesOneOf {
566
643
  /**
567
- * Physical properties.
644
+ * Physical product properties such as weight and dimensions.
568
645
  *
569
- * Required when `productType: PHYSICAL`.
646
+ * Required when `productType` is `PHYSICAL`.
570
647
  */
571
648
  physicalProperties?: V3PhysicalProperties;
572
649
  }
@@ -582,15 +659,19 @@ declare enum V3ProductType {
582
659
  type V3ProductTypeWithLiterals = V3ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
583
660
  interface V3PhysicalProperties {
584
661
  /**
585
- * Weight measurement unit.
586
- * > **Note:** Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` array in Products API requests.
662
+ * Weight measurement unit information for the product.
663
+ *
664
+ * Defines the unit of measurement (kg, lb, etc.) used for product weight calculations.
665
+ * Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` parameter.
587
666
  * @readonly
588
667
  */
589
668
  weightMeasurementUnitInfo?: V3WeightMeasurementUnitInfo;
590
669
  }
591
670
  interface V3WeightMeasurementUnitInfo {
592
671
  /**
593
- * Weight measurement unit.
672
+ * Unit of measurement for weight.
673
+ *
674
+ * Standard units include kilograms (KG), pounds (LB), ounces (OZ), and grams (G).
594
675
  * @readonly
595
676
  */
596
677
  weightMeasurementUnit?: WeightUnitWithLiterals;
@@ -619,11 +700,14 @@ declare enum InternalRowState {
619
700
  /** Variant is permanently deleted. */
620
701
  PERMANENTLY_DELETED = "PERMANENTLY_DELETED"
621
702
  }
703
+ /** @enumType */
704
+ type InternalRowStateWithLiterals = InternalRowState | 'UNKNOWN_ROW_STATE' | 'READY' | 'IN_PROCESS' | 'SOFT_DELETED' | 'PERMANENTLY_DELETED';
622
705
  interface QueryVariantsRequest {
623
- /** WQL expression. */
706
+ /** WQL expression for filtering variants. */
624
707
  query?: CursorQuery;
625
708
  /**
626
- * A list of requested fields to be included in the response.
709
+ * List of additional fields to include in the response.
710
+ * See VariantOps.RequestedFields for available options.
627
711
  * @maxSize 100
628
712
  */
629
713
  fields?: RequestedFieldsWithLiterals[];
@@ -683,20 +767,43 @@ interface CursorPaging {
683
767
  cursor?: string | null;
684
768
  }
685
769
  declare enum RequestedFields {
686
- /** Not implemented. */
770
+ /** Unknown requested field. */
687
771
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
772
+ /**
773
+ * Include currency information in product data.
774
+ *
775
+ * Returns the currency code (ISO-4217 format) used for pricing this variant.
776
+ * Defaults to the site's currency unless specified in request headers.
777
+ */
688
778
  CURRENCY = "CURRENCY",
689
- /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
779
+ /**
780
+ * Include merchant-specific data such as cost and profit information.
781
+ *
782
+ * Returns revenue details including cost, profit, and profit margin.
783
+ * Requires `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
784
+ */
690
785
  MERCHANT_DATA = "MERCHANT_DATA",
786
+ /**
787
+ * Include subscription pricing information.
788
+ *
789
+ * Returns calculated prices for different subscription plans with applied discounts.
790
+ * Only relevant for variants that are part of subscription offerings.
791
+ */
691
792
  SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
793
+ /**
794
+ * Include weight measurement unit information.
795
+ *
796
+ * Returns the weight measurement unit (kg, lb, etc.) used for the variant.
797
+ * Useful for shipping calculations and product comparisons.
798
+ */
692
799
  WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO"
693
800
  }
694
801
  /** @enumType */
695
802
  type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CURRENCY' | 'MERCHANT_DATA' | 'SUBSCRIPTION_PRICES_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO';
696
803
  interface QueryVariantsResponse {
697
- /** List of ReadOnlyVariants. */
804
+ /** Variants matching the query criteria. */
698
805
  variants?: ReadOnlyVariant[];
699
- /** Paging metadata */
806
+ /** Pagination information with cursors for next pages. */
700
807
  pagingMetadata?: CursorPagingMetadata;
701
808
  }
702
809
  interface CursorPagingMetadata {
@@ -725,10 +832,11 @@ interface Cursors {
725
832
  prev?: string | null;
726
833
  }
727
834
  interface SearchVariantsRequest {
728
- /** WQL expression */
835
+ /** WQL expression for searching variants. */
729
836
  search?: CursorSearch;
730
837
  /**
731
- * A list of requested fields to be included in the response.
838
+ * List of additional fields to include in the response.
839
+ * See VariantOps.RequestedFields for available options.
732
840
  * @maxSize 100
733
841
  */
734
842
  fields?: RequestedFieldsWithLiterals[];
@@ -1005,11 +1113,11 @@ declare enum Mode {
1005
1113
  /** @enumType */
1006
1114
  type ModeWithLiterals = Mode | 'OR' | 'AND';
1007
1115
  interface SearchVariantsResponse {
1008
- /** Variants which satisfy the provided query. */
1116
+ /** Variants matching the search criteria. */
1009
1117
  variants?: ReadOnlyVariant[];
1010
- /** Paging metadata. Contains cursor which can be used in next query. */
1118
+ /** Pagination information with cursors for next pages. */
1011
1119
  pagingMetadata?: CursorPagingMetadata;
1012
- /** Aggregation data. */
1120
+ /** Aggregation results for faceted search. */
1013
1121
  aggregationData?: AggregationData;
1014
1122
  }
1015
1123
  interface AggregationData {
@@ -1216,10 +1324,11 @@ interface AggregationResultsResultOneOf {
1216
1324
  nested?: NestedResults;
1217
1325
  }
1218
1326
  interface DeprecatedSearchVariantsWithOffsetRequest {
1219
- /** Filter and sort with limit/offset based paging */
1327
+ /** Search parameters with offset-based pagination. */
1220
1328
  search?: PlatformOffsetSearch;
1221
1329
  /**
1222
- * A list of requested fields to be included in the response.
1330
+ * List of additional fields to include in the response.
1331
+ * See VariantOps.RequestedFields for available options.
1223
1332
  * @maxSize 100
1224
1333
  */
1225
1334
  fields?: RequestedFieldsWithLiterals[];
@@ -1524,11 +1633,11 @@ interface PlatformPaging {
1524
1633
  offset?: number | null;
1525
1634
  }
1526
1635
  interface DeprecatedSearchVariantsWithOffsetResponse {
1527
- /** Products which satisfy the provided query. */
1636
+ /** Variants matching the search criteria. */
1528
1637
  variants?: ReadOnlyVariant[];
1529
- /** Paging metadata. */
1638
+ /** Pagination information for offset-based results. */
1530
1639
  pagingMetadata?: PagingMetadata;
1531
- /** Aggregation data. */
1640
+ /** Aggregation results for faceted search. */
1532
1641
  aggregationData?: Aggregation;
1533
1642
  }
1534
1643
  interface PagingMetadata {
@@ -1542,9 +1651,9 @@ interface PagingMetadata {
1542
1651
  tooManyToCount?: boolean | null;
1543
1652
  }
1544
1653
  interface MigrateProductVariantsRequest {
1545
- /** The product */
1654
+ /** Product containing variants to migrate. */
1546
1655
  product?: Product;
1547
- /** The event sequence number of the product. */
1656
+ /** Event sequence number for the migration. */
1548
1657
  eventSequence?: string | null;
1549
1658
  }
1550
1659
  interface Product extends ProductTypedPropertiesOneOf {
@@ -1727,12 +1836,6 @@ interface Product extends ProductTypedPropertiesOneOf {
1727
1836
  * @readonly
1728
1837
  */
1729
1838
  handle?: string | null;
1730
- /**
1731
- * ID of the last import job that affected the product.
1732
- * @internal
1733
- * @format GUID
1734
- */
1735
- importId?: string | null;
1736
1839
  /**
1737
1840
  * 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.
1738
1841
  *
@@ -3187,6 +3290,8 @@ declare enum NullValue {
3187
3290
  /** Null value. */
3188
3291
  NULL_VALUE = "NULL_VALUE"
3189
3292
  }
3293
+ /** @enumType */
3294
+ type NullValueWithLiterals = NullValue | 'NULL_VALUE';
3190
3295
  /**
3191
3296
  * `ListValue` is a wrapper around a repeated field of values.
3192
3297
  *
@@ -4597,9 +4702,26 @@ declare enum WebhookIdentityType {
4597
4702
  }
4598
4703
  /** @enumType */
4599
4704
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
4705
+ /**
4706
+ * Retrieve product variants using structured queries with cursor-based pagination.
4707
+ *
4708
+ * Use this endpoint for simple filtering operations on `id` and `productId`.
4709
+ * For complex queries with free-text search and aggregations, use Search Variants instead.
4710
+ *
4711
+ * Up to 1,000 variants can be returned per request.
4712
+ * @public
4713
+ * @documentationMaturity preview
4714
+ * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ
4715
+ * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN
4716
+ * @applicableIdentity APP
4717
+ * @applicableIdentity VISITOR
4718
+ * @fqn com.wix.stores.catalog.product.variants.reader.api.v3.ProductVariantsReader.QueryVariants
4719
+ */
4720
+ declare function queryVariants(options?: QueryVariantsOptions): VariantsQueryBuilder;
4600
4721
  interface QueryVariantsOptions {
4601
4722
  /**
4602
- * A list of requested fields to be included in the response.
4723
+ * List of additional fields to include in the response.
4724
+ * See VariantOps.RequestedFields for available options.
4603
4725
  * @maxSize 100
4604
4726
  */
4605
4727
  fields?: RequestedFieldsWithLiterals[] | undefined;
@@ -4683,7 +4805,8 @@ interface VariantsQueryBuilder {
4683
4805
  }
4684
4806
  interface SearchVariantsOptions {
4685
4807
  /**
4686
- * A list of requested fields to be included in the response.
4808
+ * List of additional fields to include in the response.
4809
+ * See VariantOps.RequestedFields for available options.
4687
4810
  * @maxSize 100
4688
4811
  */
4689
4812
  fields?: RequestedFieldsWithLiterals[];
@@ -4716,7 +4839,7 @@ interface ReadOnlyVariantSearchSpec extends SearchSpec {
4716
4839
  'optionChoices.optionChoiceIds.choiceId',
4717
4840
  'optionChoices.optionChoiceIds.optionId'
4718
4841
  ];
4719
- sort: 'NONE';
4842
+ sort: 'BOTH';
4720
4843
  },
4721
4844
  {
4722
4845
  operators: '*';
@@ -4737,7 +4860,7 @@ interface ReadOnlyVariantSearchSpec extends SearchSpec {
4737
4860
  'sku',
4738
4861
  'visible'
4739
4862
  ];
4740
- sort: 'NONE';
4863
+ sort: 'BOTH';
4741
4864
  }
4742
4865
  ];
4743
4866
  }
@@ -4858,4 +4981,4 @@ type ReadOnlyVariantSearch = {
4858
4981
  timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
4859
4982
  };
4860
4983
 
4861
- export { DecorationType as $, AggregationType as A, LayoutType as B, CommonSortOrder as C, DateHistogramAggregationInterval as D, Crop as E, ThumbnailsAlignment as F, GIFType as G, Source as H, InternalRowState as I, Position as J, MapType as K, LineStyle as L, MeasurementUnit as M, NestedAggregationType as N, Orientation as O, ProductMediaMediaType as P, type QueryVariantsOptions as Q, type ReadOnlyVariantSearch as R, type SearchVariantsOptions as S, Type as T, ViewRole as U, type VariantsQueryBuilder as V, WeightUnit as W, VoteRole as X, PollLayoutType as Y, PollLayoutDirection as Z, BackgroundType as _, type SearchVariantsResponse as a, type ScalarAggregation as a$, FontType as a0, AppType as a1, InitialExpandedItems as a2, Direction as a3, VerticalAlignment as a4, NullValue as a5, MediaType as a6, ProductOptionRenderType as a7, ChoiceType as a8, ModifierRenderType as a9, type V3SubscriptionPricesInfo as aA, type V3SubscriptionPrice as aB, type V3SubscriptionPricePerUnit as aC, type V3InventoryStatus as aD, type ProductFields as aE, type ProductFieldsTypedPropertiesOneOf as aF, type V3PhysicalProperties as aG, type V3WeightMeasurementUnitInfo as aH, type InternalMetadata as aI, type QueryVariantsRequest as aJ, type CursorQuery as aK, type CursorQueryPagingMethodOneOf as aL, type Sorting as aM, type CursorPaging as aN, type QueryVariantsResponse as aO, type CursorPagingMetadata as aP, type Cursors as aQ, type SearchVariantsRequest as aR, type CursorSearch as aS, type CursorSearchPagingMethodOneOf as aT, type Aggregation as aU, type AggregationKindOneOf as aV, type RangeBucket as aW, type IncludeMissingValuesOptions as aX, type ValueAggregation as aY, type ValueAggregationOptionsOneOf as aZ, type RangeAggregation as a_, AvailabilityStatus as aa, PreorderStatus as ab, ProductPreorderAvailability as ac, ProductType as ad, FileType as ae, SubscriptionFrequency as af, DiscountType as ag, WebhookIdentityType as ah, type ReadOnlyVariant as ai, type ReadOnlyVariantTypedPropertiesOneOf as aj, type V3OptionChoice as ak, type V3OptionChoiceIds as al, type V3OptionChoiceNames as am, type V3PriceInfo as an, type V3FixedMonetaryAmount as ao, type V3RevenueDetails as ap, type V3ProductMedia as aq, type V3ProductMediaSetByOneOf as ar, type V3ProductMediaMediaOneOf as as, type CommonVideoResolution as at, type V3Thumbnail as au, type V3VariantPhysicalProperties as av, type V3PricePerUnit as aw, type V3PricePerUnitSettings as ax, type V3VariantDigitalProperties as ay, type V3SecuredMedia as az, SecuredMediaFileType as b, type Styles as b$, type DateHistogramAggregation as b0, type NestedAggregationItem as b1, type NestedAggregationItemKindOneOf as b2, type NestedAggregation as b3, type SearchDetails as b4, type AggregationData as b5, type ValueAggregationResult as b6, type RangeAggregationResult as b7, type NestedAggregationResults as b8, type NestedAggregationResultsResultOneOf as b9, type AggregationRangeAggregation as bA, type AggregationScalarAggregation as bB, type AggregationDateHistogramAggregation as bC, type NestedAggregationNestedAggregationItem as bD, type NestedAggregationNestedAggregationItemKindOneOf as bE, type AggregationNestedAggregation as bF, type GroupByAggregation as bG, type GroupByAggregationKindOneOf as bH, type CommonSearchDetails as bI, type PlatformPaging as bJ, type DeprecatedSearchVariantsWithOffsetResponse as bK, type PagingMetadata as bL, type MigrateProductVariantsRequest as bM, type Product as bN, type ProductTypedPropertiesOneOf as bO, type RichContent as bP, type Node as bQ, type NodeDataOneOf as bR, type NodeStyle as bS, type ButtonData as bT, type Border as bU, type Colors as bV, type PluginContainerData as bW, type PluginContainerDataWidth as bX, type PluginContainerDataWidthDataOneOf as bY, type Spoiler as bZ, type Height as b_, type ValueResults as ba, type RangeResults as bb, type AggregationResultsScalarResult as bc, type NestedValueAggregationResult as bd, type ValueResult as be, type RangeResult as bf, type ScalarResult as bg, type NestedResultValue as bh, type NestedResultValueResultOneOf as bi, type Results as bj, type DateHistogramResult as bk, type GroupByValueResults as bl, type DateHistogramResults as bm, type NestedResults as bn, type AggregationResults as bo, type AggregationResultsResultOneOf as bp, type DeprecatedSearchVariantsWithOffsetRequest as bq, type PlatformOffsetSearch as br, type PlatformOffsetSearchPagingMethodOneOf as bs, type CommonSorting as bt, type CommonAggregation as bu, type CommonAggregationKindOneOf as bv, type RangeAggregationRangeBucket as bw, type ValueAggregationIncludeMissingValuesOptions as bx, type AggregationValueAggregation as by, type AggregationValueAggregationOptionsOneOf as bz, V3ProductType as c, type Oembed as c$, type Link as c0, type LinkDataOneOf as c1, type Rel as c2, type CodeBlockData as c3, type TextStyle as c4, type DividerData as c5, type FileData as c6, type FileSource as c7, type FileSourceDataOneOf as c8, type PDFSettings as c9, type PollSettings as cA, type PollLayout as cB, type OptionLayout as cC, type Gradient as cD, type Background as cE, type BackgroundBackgroundOneOf as cF, type PollDesign as cG, type OptionDesign as cH, type Poll as cI, type PollDataLayout as cJ, type Design as cK, type TextData as cL, type Decoration as cM, type DecorationDataOneOf as cN, type AnchorData as cO, type ColorData as cP, type LinkData as cQ, type MentionData as cR, type FontSizeData as cS, type SpoilerData as cT, type AppEmbedData as cU, type AppEmbedDataAppDataOneOf as cV, type BookingData as cW, type EventData as cX, type VideoData as cY, type PlaybackOptions as cZ, type EmbedData as c_, type GalleryData as ca, type V1Media as cb, type Image as cc, type Video as cd, type Item as ce, type ItemDataOneOf as cf, type GalleryOptions as cg, type Layout as ch, type ItemStyle as ci, type Thumbnails as cj, type GIFData as ck, type GIF as cl, type HeadingData as cm, type HTMLData as cn, type HTMLDataDataOneOf as co, type ImageData as cp, type StylesBorder as cq, type ImageDataStyles as cr, type LinkPreviewData as cs, type LinkPreviewDataStyles as ct, type MapData as cu, type MapSettings as cv, type ParagraphData as cw, type PollData as cx, type Permissions as cy, type Option as cz, SortOrder as d, type PriceInfo as d$, type CollapsibleListData as d0, type TableData as d1, type Dimensions as d2, type TableCellData as d3, type CellStyle as d4, type BorderColors as d5, type ListValue as d6, type AudioData as d7, type OrderedListData as d8, type BulletedListData as d9, type FreeTextSettings as dA, type ModifierChoicesSettings as dB, type ConnectedModifierChoice as dC, type ConnectedModifierChoiceValueOneOf as dD, type Brand as dE, type InfoSection as dF, type Ribbon as dG, type ProductCategoriesInfo as dH, type ProductCategory as dI, type ProductCategoryIdsInfo as dJ, type PriceRange as dK, type FixedMonetaryAmount as dL, type Inventory as dM, type PhysicalProperties as dN, type PricePerUnitSettings as dO, type WeightRange as dP, type PricePerUnitRange as dQ, type PricePerUnitRangePricePerUnit as dR, type WeightMeasurementUnitInfo as dS, type BreadcrumbsInfo as dT, type BreadCrumb as dU, type VariantsInfo as dV, type Variant as dW, type VariantTypedPropertiesOneOf as dX, type OptionChoice as dY, type OptionChoiceIds as dZ, type OptionChoiceNames as d_, type BlockquoteData as da, type CaptionData as db, type LayoutCellData as dc, type Metadata as dd, type DocumentStyle as de, type TextNodeStyle as df, type Media as dg, type ProductMedia as dh, type ProductMediaSetByOneOf as di, type ProductMediaMediaOneOf as dj, type VideoResolution as dk, type Thumbnail as dl, type MediaItemsInfo as dm, type SeoSchema as dn, type Keyword as dp, type Tag as dq, type Settings as dr, type ConnectedOption as ds, type ConnectedOptionOptionSettingsOneOf as dt, type ChoicesSettings as du, type ConnectedOptionChoice as dv, type ConnectedOptionChoiceValueOneOf as dw, type MultipleColors as dx, type ConnectedModifier as dy, type ConnectedModifierModifierSettingsOneOf as dz, RequestedFields as e, type RevenueDetails as e0, type VariantPhysicalProperties as e1, type PricePerUnit as e2, type VariantDigitalProperties as e3, type SecuredMedia as e4, type SubscriptionPricesInfo as e5, type SubscriptionPrice as e6, type SubscriptionPricePerUnit as e7, type InventoryStatus as e8, type ExtendedFields as e9, type SubscriptionDetails as ea, type Subscription as eb, type SubscriptionCyclesOneOf as ec, type SubscriptionDiscount as ed, type SubscriptionDiscountDiscountOneOf as ee, type VariantSummary as ef, type MinVariantPriceInfo as eg, type MigrateProductVariantsResponse as eh, type RecoverProductVariantsRequest as ei, type RecoverProductVariantsResponse as ej, type DomainEvent as ek, type DomainEventBodyOneOf as el, type EntityCreatedEvent as em, type RestoreInfo as en, type EntityUpdatedEvent as eo, type EntityDeletedEvent as ep, type ActionEvent as eq, type Empty as er, type MessageEnvelope as es, type IdentificationData as et, type IdentificationDataIdOneOf as eu, type VariantsQueryResult as ev, type ReadOnlyVariantSearchSpec as ew, SortType as f, SortDirection as g, MissingValues as h, ScalarType as i, Interval as j, Mode as k, ValueAggregationSortType as l, ValueAggregationSortDirection as m, ValueAggregationMissingValues as n, CommonScalarType as o, NestedAggregationNestedAggregationType as p, CommonAggregationType as q, SearchDetailsMode as r, NodeType as s, WidthType as t, PluginContainerDataAlignment as u, Target as v, TextAlignment as w, Width as x, Alignment as y, ViewMode as z };
4984
+ export { DecorationType as $, AggregationType as A, LayoutType as B, CommonSortOrder as C, DateHistogramAggregationInterval as D, Crop as E, ThumbnailsAlignment as F, GIFType as G, Source as H, InternalRowState as I, Position as J, MapType as K, LineStyle as L, MeasurementUnit as M, NestedAggregationType as N, Orientation as O, ProductMediaMediaType as P, type QueryVariantsOptions as Q, type ReadOnlyVariantSearch as R, type SearchVariantsOptions as S, Type as T, ViewRole as U, type VariantsQueryBuilder as V, WeightUnit as W, VoteRole as X, PollLayoutType as Y, PollLayoutDirection as Z, BackgroundType as _, type SearchVariantsResponse as a, type ScalarAggregation as a$, FontType as a0, AppType as a1, InitialExpandedItems as a2, Direction as a3, VerticalAlignment as a4, NullValue as a5, MediaType as a6, ProductOptionRenderType as a7, ChoiceType as a8, ModifierRenderType as a9, type V3SubscriptionPricesInfo as aA, type V3SubscriptionPrice as aB, type V3SubscriptionPricePerUnit as aC, type V3InventoryStatus as aD, type ProductFields as aE, type ProductFieldsTypedPropertiesOneOf as aF, type V3PhysicalProperties as aG, type V3WeightMeasurementUnitInfo as aH, type InternalMetadata as aI, type QueryVariantsRequest as aJ, type CursorQuery as aK, type CursorQueryPagingMethodOneOf as aL, type Sorting as aM, type CursorPaging as aN, type QueryVariantsResponse as aO, type CursorPagingMetadata as aP, type Cursors as aQ, type SearchVariantsRequest as aR, type CursorSearch as aS, type CursorSearchPagingMethodOneOf as aT, type Aggregation as aU, type AggregationKindOneOf as aV, type RangeBucket as aW, type IncludeMissingValuesOptions as aX, type ValueAggregation as aY, type ValueAggregationOptionsOneOf as aZ, type RangeAggregation as a_, AvailabilityStatus as aa, PreorderStatus as ab, ProductPreorderAvailability as ac, ProductType as ad, FileType as ae, SubscriptionFrequency as af, DiscountType as ag, WebhookIdentityType as ah, type ReadOnlyVariant as ai, type ReadOnlyVariantTypedPropertiesOneOf as aj, type V3OptionChoice as ak, type V3OptionChoiceIds as al, type V3OptionChoiceNames as am, type V3PriceInfo as an, type V3FixedMonetaryAmount as ao, type V3RevenueDetails as ap, type V3ProductMedia as aq, type V3ProductMediaSetByOneOf as ar, type V3ProductMediaMediaOneOf as as, type CommonVideoResolution as at, type V3Thumbnail as au, type V3VariantPhysicalProperties as av, type V3PricePerUnit as aw, type V3PricePerUnitSettings as ax, type V3VariantDigitalProperties as ay, type V3SecuredMedia as az, SecuredMediaFileType as b, type Styles as b$, type DateHistogramAggregation as b0, type NestedAggregationItem as b1, type NestedAggregationItemKindOneOf as b2, type NestedAggregation as b3, type SearchDetails as b4, type AggregationData as b5, type ValueAggregationResult as b6, type RangeAggregationResult as b7, type NestedAggregationResults as b8, type NestedAggregationResultsResultOneOf as b9, type AggregationRangeAggregation as bA, type AggregationScalarAggregation as bB, type AggregationDateHistogramAggregation as bC, type NestedAggregationNestedAggregationItem as bD, type NestedAggregationNestedAggregationItemKindOneOf as bE, type AggregationNestedAggregation as bF, type GroupByAggregation as bG, type GroupByAggregationKindOneOf as bH, type CommonSearchDetails as bI, type PlatformPaging as bJ, type DeprecatedSearchVariantsWithOffsetResponse as bK, type PagingMetadata as bL, type MigrateProductVariantsRequest as bM, type Product as bN, type ProductTypedPropertiesOneOf as bO, type RichContent as bP, type Node as bQ, type NodeDataOneOf as bR, type NodeStyle as bS, type ButtonData as bT, type Border as bU, type Colors as bV, type PluginContainerData as bW, type PluginContainerDataWidth as bX, type PluginContainerDataWidthDataOneOf as bY, type Spoiler as bZ, type Height as b_, type ValueResults as ba, type RangeResults as bb, type AggregationResultsScalarResult as bc, type NestedValueAggregationResult as bd, type ValueResult as be, type RangeResult as bf, type ScalarResult as bg, type NestedResultValue as bh, type NestedResultValueResultOneOf as bi, type Results as bj, type DateHistogramResult as bk, type GroupByValueResults as bl, type DateHistogramResults as bm, type NestedResults as bn, type AggregationResults as bo, type AggregationResultsResultOneOf as bp, type DeprecatedSearchVariantsWithOffsetRequest as bq, type PlatformOffsetSearch as br, type PlatformOffsetSearchPagingMethodOneOf as bs, type CommonSorting as bt, type CommonAggregation as bu, type CommonAggregationKindOneOf as bv, type RangeAggregationRangeBucket as bw, type ValueAggregationIncludeMissingValuesOptions as bx, type AggregationValueAggregation as by, type AggregationValueAggregationOptionsOneOf as bz, V3ProductType as c, type Oembed as c$, type Link as c0, type LinkDataOneOf as c1, type Rel as c2, type CodeBlockData as c3, type TextStyle as c4, type DividerData as c5, type FileData as c6, type FileSource as c7, type FileSourceDataOneOf as c8, type PDFSettings as c9, type PollSettings as cA, type PollLayout as cB, type OptionLayout as cC, type Gradient as cD, type Background as cE, type BackgroundBackgroundOneOf as cF, type PollDesign as cG, type OptionDesign as cH, type Poll as cI, type PollDataLayout as cJ, type Design as cK, type TextData as cL, type Decoration as cM, type DecorationDataOneOf as cN, type AnchorData as cO, type ColorData as cP, type LinkData as cQ, type MentionData as cR, type FontSizeData as cS, type SpoilerData as cT, type AppEmbedData as cU, type AppEmbedDataAppDataOneOf as cV, type BookingData as cW, type EventData as cX, type VideoData as cY, type PlaybackOptions as cZ, type EmbedData as c_, type GalleryData as ca, type V1Media as cb, type Image as cc, type Video as cd, type Item as ce, type ItemDataOneOf as cf, type GalleryOptions as cg, type Layout as ch, type ItemStyle as ci, type Thumbnails as cj, type GIFData as ck, type GIF as cl, type HeadingData as cm, type HTMLData as cn, type HTMLDataDataOneOf as co, type ImageData as cp, type StylesBorder as cq, type ImageDataStyles as cr, type LinkPreviewData as cs, type LinkPreviewDataStyles as ct, type MapData as cu, type MapSettings as cv, type ParagraphData as cw, type PollData as cx, type Permissions as cy, type Option as cz, SortOrder as d, type PriceInfo as d$, type CollapsibleListData as d0, type TableData as d1, type Dimensions as d2, type TableCellData as d3, type CellStyle as d4, type BorderColors as d5, type ListValue as d6, type AudioData as d7, type OrderedListData as d8, type BulletedListData as d9, type FreeTextSettings as dA, type ModifierChoicesSettings as dB, type ConnectedModifierChoice as dC, type ConnectedModifierChoiceValueOneOf as dD, type Brand as dE, type InfoSection as dF, type Ribbon as dG, type ProductCategoriesInfo as dH, type ProductCategory as dI, type ProductCategoryIdsInfo as dJ, type PriceRange as dK, type FixedMonetaryAmount as dL, type Inventory as dM, type PhysicalProperties as dN, type PricePerUnitSettings as dO, type WeightRange as dP, type PricePerUnitRange as dQ, type PricePerUnitRangePricePerUnit as dR, type WeightMeasurementUnitInfo as dS, type BreadcrumbsInfo as dT, type BreadCrumb as dU, type VariantsInfo as dV, type Variant as dW, type VariantTypedPropertiesOneOf as dX, type OptionChoice as dY, type OptionChoiceIds as dZ, type OptionChoiceNames as d_, type BlockquoteData as da, type CaptionData as db, type LayoutCellData as dc, type Metadata as dd, type DocumentStyle as de, type TextNodeStyle as df, type Media as dg, type ProductMedia as dh, type ProductMediaSetByOneOf as di, type ProductMediaMediaOneOf as dj, type VideoResolution as dk, type Thumbnail as dl, type MediaItemsInfo as dm, type SeoSchema as dn, type Keyword as dp, type Tag as dq, type Settings as dr, type ConnectedOption as ds, type ConnectedOptionOptionSettingsOneOf as dt, type ChoicesSettings as du, type ConnectedOptionChoice as dv, type ConnectedOptionChoiceValueOneOf as dw, type MultipleColors as dx, type ConnectedModifier as dy, type ConnectedModifierModifierSettingsOneOf as dz, RequestedFields as e, type TextAlignmentWithLiterals as e$, type RevenueDetails as e0, type VariantPhysicalProperties as e1, type PricePerUnit as e2, type VariantDigitalProperties as e3, type SecuredMedia as e4, type SubscriptionPricesInfo as e5, type SubscriptionPrice as e6, type SubscriptionPricePerUnit as e7, type InventoryStatus as e8, type ExtendedFields as e9, type V3ProductTypeWithLiterals as eA, type WeightUnitWithLiterals as eB, type InternalRowStateWithLiterals as eC, type SortOrderWithLiterals as eD, type RequestedFieldsWithLiterals as eE, type SortTypeWithLiterals as eF, type SortDirectionWithLiterals as eG, type MissingValuesWithLiterals as eH, type ScalarTypeWithLiterals as eI, type NestedAggregationTypeWithLiterals as eJ, type IntervalWithLiterals as eK, type AggregationTypeWithLiterals as eL, type ModeWithLiterals as eM, type CommonSortOrderWithLiterals as eN, type ValueAggregationSortTypeWithLiterals as eO, type ValueAggregationSortDirectionWithLiterals as eP, type ValueAggregationMissingValuesWithLiterals as eQ, type CommonScalarTypeWithLiterals as eR, type NestedAggregationNestedAggregationTypeWithLiterals as eS, type DateHistogramAggregationIntervalWithLiterals as eT, type CommonAggregationTypeWithLiterals as eU, type SearchDetailsModeWithLiterals as eV, type NodeTypeWithLiterals as eW, type WidthTypeWithLiterals as eX, type PluginContainerDataAlignmentWithLiterals as eY, type TypeWithLiterals as eZ, type TargetWithLiterals as e_, type SubscriptionDetails as ea, type Subscription as eb, type SubscriptionCyclesOneOf as ec, type SubscriptionDiscount as ed, type SubscriptionDiscountDiscountOneOf as ee, type VariantSummary as ef, type MinVariantPriceInfo as eg, type MigrateProductVariantsResponse as eh, type RecoverProductVariantsRequest as ei, type RecoverProductVariantsResponse as ej, type DomainEvent as ek, type DomainEventBodyOneOf as el, type EntityCreatedEvent as em, type RestoreInfo as en, type EntityUpdatedEvent as eo, type EntityDeletedEvent as ep, type ActionEvent as eq, type Empty as er, type MessageEnvelope as es, type IdentificationData as et, type IdentificationDataIdOneOf as eu, type VariantsQueryResult as ev, type ReadOnlyVariantSearchSpec as ew, type ProductMediaMediaTypeWithLiterals as ex, type MeasurementUnitWithLiterals as ey, type SecuredMediaFileTypeWithLiterals as ez, SortType as f, type LineStyleWithLiterals as f0, type WidthWithLiterals as f1, type AlignmentWithLiterals as f2, type ViewModeWithLiterals as f3, type LayoutTypeWithLiterals as f4, type OrientationWithLiterals as f5, type CropWithLiterals as f6, type ThumbnailsAlignmentWithLiterals as f7, type GIFTypeWithLiterals as f8, type SourceWithLiterals as f9, queryVariants as fA, type CommonSearchWithEntityContext as fB, type PositionWithLiterals as fa, type MapTypeWithLiterals as fb, type ViewRoleWithLiterals as fc, type VoteRoleWithLiterals as fd, type PollLayoutTypeWithLiterals as fe, type PollLayoutDirectionWithLiterals as ff, type BackgroundTypeWithLiterals as fg, type DecorationTypeWithLiterals as fh, type FontTypeWithLiterals as fi, type AppTypeWithLiterals as fj, type InitialExpandedItemsWithLiterals as fk, type DirectionWithLiterals as fl, type VerticalAlignmentWithLiterals as fm, type NullValueWithLiterals as fn, type MediaTypeWithLiterals as fo, type ProductOptionRenderTypeWithLiterals as fp, type ChoiceTypeWithLiterals as fq, type ModifierRenderTypeWithLiterals as fr, type AvailabilityStatusWithLiterals as fs, type PreorderStatusWithLiterals as ft, type ProductPreorderAvailabilityWithLiterals as fu, type ProductTypeWithLiterals as fv, type FileTypeWithLiterals as fw, type SubscriptionFrequencyWithLiterals as fx, type DiscountTypeWithLiterals as fy, type WebhookIdentityTypeWithLiterals as fz, SortDirection as g, MissingValues as h, ScalarType as i, Interval as j, Mode as k, ValueAggregationSortType as l, ValueAggregationSortDirection as m, ValueAggregationMissingValues as n, CommonScalarType as o, NestedAggregationNestedAggregationType as p, CommonAggregationType as q, SearchDetailsMode as r, NodeType as s, WidthType as t, PluginContainerDataAlignment as u, Target as v, TextAlignment as w, Width as x, Alignment as y, ViewMode as z };