@wix/auto_sdk_stores_read-only-variants-v-3 1.0.16 → 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 (29) hide show
  1. package/build/cjs/index.d.ts +35 -2
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +22 -2
  4. package/build/cjs/index.typings.js.map +1 -1
  5. package/build/cjs/meta.d.ts +187 -81
  6. package/build/cjs/meta.js.map +1 -1
  7. package/build/{internal/cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DmrKxIKF.d.ts → cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BvjIOy5Y.d.ts} +207 -103
  8. package/build/es/index.d.mts +35 -2
  9. package/build/es/index.mjs.map +1 -1
  10. package/build/es/index.typings.d.mts +22 -2
  11. package/build/es/index.typings.mjs.map +1 -1
  12. package/build/es/meta.d.mts +187 -81
  13. package/build/es/meta.mjs.map +1 -1
  14. package/build/{internal/es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DmrKxIKF.d.mts → es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-BvjIOy5Y.d.mts} +207 -103
  15. package/build/internal/cjs/index.d.ts +16 -16
  16. package/build/internal/cjs/index.js.map +1 -1
  17. package/build/internal/cjs/index.typings.d.ts +11 -8
  18. package/build/internal/cjs/index.typings.js.map +1 -1
  19. package/build/internal/cjs/meta.d.ts +187 -81
  20. package/build/internal/cjs/meta.js.map +1 -1
  21. package/build/{cjs/index-CFBlj8M-.d.ts → internal/cjs/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DwK-NZst.d.ts} +338 -92
  22. package/build/internal/es/index.d.mts +16 -16
  23. package/build/internal/es/index.mjs.map +1 -1
  24. package/build/internal/es/index.typings.d.mts +11 -8
  25. package/build/internal/es/index.typings.mjs.map +1 -1
  26. package/build/internal/es/meta.d.mts +187 -81
  27. package/build/internal/es/meta.mjs.map +1 -1
  28. package/build/{es/index-CFBlj8M-.d.mts → internal/es/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DwK-NZst.d.mts} +338 -92
  29. 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;
@@ -622,10 +703,11 @@ declare enum InternalRowState {
622
703
  /** @enumType */
623
704
  type InternalRowStateWithLiterals = InternalRowState | 'UNKNOWN_ROW_STATE' | 'READY' | 'IN_PROCESS' | 'SOFT_DELETED' | 'PERMANENTLY_DELETED';
624
705
  interface QueryVariantsRequest {
625
- /** WQL expression. */
706
+ /** WQL expression for filtering variants. */
626
707
  query?: CursorQuery;
627
708
  /**
628
- * 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.
629
711
  * @maxSize 100
630
712
  */
631
713
  fields?: RequestedFieldsWithLiterals[];
@@ -685,20 +767,43 @@ interface CursorPaging {
685
767
  cursor?: string | null;
686
768
  }
687
769
  declare enum RequestedFields {
688
- /** Not implemented. */
770
+ /** Unknown requested field. */
689
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
+ */
690
778
  CURRENCY = "CURRENCY",
691
- /** 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
+ */
692
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
+ */
693
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
+ */
694
799
  WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO"
695
800
  }
696
801
  /** @enumType */
697
802
  type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CURRENCY' | 'MERCHANT_DATA' | 'SUBSCRIPTION_PRICES_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO';
698
803
  interface QueryVariantsResponse {
699
- /** List of ReadOnlyVariants. */
804
+ /** Variants matching the query criteria. */
700
805
  variants?: ReadOnlyVariant[];
701
- /** Paging metadata */
806
+ /** Pagination information with cursors for next pages. */
702
807
  pagingMetadata?: CursorPagingMetadata;
703
808
  }
704
809
  interface CursorPagingMetadata {
@@ -727,10 +832,11 @@ interface Cursors {
727
832
  prev?: string | null;
728
833
  }
729
834
  interface SearchVariantsRequest {
730
- /** WQL expression */
835
+ /** WQL expression for searching variants. */
731
836
  search?: CursorSearch;
732
837
  /**
733
- * 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.
734
840
  * @maxSize 100
735
841
  */
736
842
  fields?: RequestedFieldsWithLiterals[];
@@ -1007,11 +1113,11 @@ declare enum Mode {
1007
1113
  /** @enumType */
1008
1114
  type ModeWithLiterals = Mode | 'OR' | 'AND';
1009
1115
  interface SearchVariantsResponse {
1010
- /** Variants which satisfy the provided query. */
1116
+ /** Variants matching the search criteria. */
1011
1117
  variants?: ReadOnlyVariant[];
1012
- /** Paging metadata. Contains cursor which can be used in next query. */
1118
+ /** Pagination information with cursors for next pages. */
1013
1119
  pagingMetadata?: CursorPagingMetadata;
1014
- /** Aggregation data. */
1120
+ /** Aggregation results for faceted search. */
1015
1121
  aggregationData?: AggregationData;
1016
1122
  }
1017
1123
  interface AggregationData {
@@ -1218,10 +1324,11 @@ interface AggregationResultsResultOneOf {
1218
1324
  nested?: NestedResults;
1219
1325
  }
1220
1326
  interface DeprecatedSearchVariantsWithOffsetRequest {
1221
- /** Filter and sort with limit/offset based paging */
1327
+ /** Search parameters with offset-based pagination. */
1222
1328
  search?: PlatformOffsetSearch;
1223
1329
  /**
1224
- * 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.
1225
1332
  * @maxSize 100
1226
1333
  */
1227
1334
  fields?: RequestedFieldsWithLiterals[];
@@ -1526,11 +1633,11 @@ interface PlatformPaging {
1526
1633
  offset?: number | null;
1527
1634
  }
1528
1635
  interface DeprecatedSearchVariantsWithOffsetResponse {
1529
- /** Products which satisfy the provided query. */
1636
+ /** Variants matching the search criteria. */
1530
1637
  variants?: ReadOnlyVariant[];
1531
- /** Paging metadata. */
1638
+ /** Pagination information for offset-based results. */
1532
1639
  pagingMetadata?: PagingMetadata;
1533
- /** Aggregation data. */
1640
+ /** Aggregation results for faceted search. */
1534
1641
  aggregationData?: Aggregation;
1535
1642
  }
1536
1643
  interface PagingMetadata {
@@ -1544,9 +1651,9 @@ interface PagingMetadata {
1544
1651
  tooManyToCount?: boolean | null;
1545
1652
  }
1546
1653
  interface MigrateProductVariantsRequest {
1547
- /** The product */
1654
+ /** Product containing variants to migrate. */
1548
1655
  product?: Product;
1549
- /** The event sequence number of the product. */
1656
+ /** Event sequence number for the migration. */
1550
1657
  eventSequence?: string | null;
1551
1658
  }
1552
1659
  interface Product extends ProductTypedPropertiesOneOf {
@@ -1729,6 +1836,12 @@ interface Product extends ProductTypedPropertiesOneOf {
1729
1836
  * @readonly
1730
1837
  */
1731
1838
  handle?: string | null;
1839
+ /**
1840
+ * ID of the last import job that affected the product.
1841
+ * @internal
1842
+ * @format GUID
1843
+ */
1844
+ importId?: string | null;
1732
1845
  /**
1733
1846
  * 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.
1734
1847
  *
@@ -4595,9 +4708,26 @@ declare enum WebhookIdentityType {
4595
4708
  }
4596
4709
  /** @enumType */
4597
4710
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
4711
+ /**
4712
+ * Retrieve product variants using structured queries with cursor-based pagination.
4713
+ *
4714
+ * Use this endpoint for simple filtering operations on `id` and `productId`.
4715
+ * For complex queries with free-text search and aggregations, use Search Variants instead.
4716
+ *
4717
+ * Up to 1,000 variants can be returned per request.
4718
+ * @public
4719
+ * @documentationMaturity preview
4720
+ * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ
4721
+ * @permissionId WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN
4722
+ * @applicableIdentity APP
4723
+ * @applicableIdentity VISITOR
4724
+ * @fqn com.wix.stores.catalog.product.variants.reader.api.v3.ProductVariantsReader.QueryVariants
4725
+ */
4726
+ declare function queryVariants(options?: QueryVariantsOptions): VariantsQueryBuilder;
4598
4727
  interface QueryVariantsOptions {
4599
4728
  /**
4600
- * A list of requested fields to be included in the response.
4729
+ * List of additional fields to include in the response.
4730
+ * See VariantOps.RequestedFields for available options.
4601
4731
  * @maxSize 100
4602
4732
  */
4603
4733
  fields?: RequestedFieldsWithLiterals[] | undefined;
@@ -4681,7 +4811,8 @@ interface VariantsQueryBuilder {
4681
4811
  }
4682
4812
  interface SearchVariantsOptions {
4683
4813
  /**
4684
- * A list of requested fields to be included in the response.
4814
+ * List of additional fields to include in the response.
4815
+ * See VariantOps.RequestedFields for available options.
4685
4816
  * @maxSize 100
4686
4817
  */
4687
4818
  fields?: RequestedFieldsWithLiterals[];
@@ -4714,7 +4845,7 @@ interface ReadOnlyVariantSearchSpec extends SearchSpec {
4714
4845
  'optionChoices.optionChoiceIds.choiceId',
4715
4846
  'optionChoices.optionChoiceIds.optionId'
4716
4847
  ];
4717
- sort: 'NONE';
4848
+ sort: 'BOTH';
4718
4849
  },
4719
4850
  {
4720
4851
  operators: '*';
@@ -4735,10 +4866,125 @@ interface ReadOnlyVariantSearchSpec extends SearchSpec {
4735
4866
  'sku',
4736
4867
  'visible'
4737
4868
  ];
4738
- sort: 'NONE';
4869
+ sort: 'BOTH';
4739
4870
  }
4740
4871
  ];
4741
4872
  }
4742
4873
  type CommonSearchWithEntityContext = Search<ReadOnlyVariant, ReadOnlyVariantSearchSpec>;
4874
+ type ReadOnlyVariantSearch = {
4875
+ /**
4876
+ Cursor pointing to page of results.
4877
+ When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
4878
+ */
4879
+ cursorPaging?: {
4880
+ /**
4881
+ Maximum number of items to return in the results.
4882
+ @max: 1000
4883
+ */
4884
+ limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
4885
+ /**
4886
+ Pointer to the next or previous page in the list of results.
4887
+
4888
+ Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
4889
+ Not relevant for the first request.
4890
+ @maxLength: 16000
4891
+ */
4892
+ cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
4893
+ };
4894
+ /**
4895
+ A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
4896
+ */
4897
+ filter?: CommonSearchWithEntityContext['filter'] | null;
4898
+ /**
4899
+ Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4900
+ @maxSize: 10
4901
+ */
4902
+ sort?: {
4903
+ /**
4904
+ Name of the field to sort by.
4905
+ @maxLength: 512
4906
+ */
4907
+ fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
4908
+ /**
4909
+ Sort order.
4910
+ */
4911
+ order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
4912
+ }[];
4913
+ /**
4914
+ Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
4915
+ @maxSize: 10
4916
+ */
4917
+ aggregations?: {
4918
+ /**
4919
+ Value aggregation
4920
+ */
4921
+ value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
4922
+ /**
4923
+ Range aggregation
4924
+ */
4925
+ range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
4926
+ /**
4927
+ Scalar aggregation
4928
+ */
4929
+ scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
4930
+ /**
4931
+ Date histogram aggregation
4932
+ */
4933
+ dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
4934
+ /**
4935
+ Nested aggregation
4936
+ */
4937
+ nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
4938
+ /**
4939
+ User-defined name of aggregation, should be unique, will appear in aggregation results
4940
+ @maxLength: 100
4941
+ */
4942
+ name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
4943
+ /**
4944
+ Type of aggregation, client must provide matching aggregation field below
4945
+ */
4946
+ type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
4947
+ /**
4948
+ Field to aggregate by, use dot notation to specify json path
4949
+ @maxLength: 200
4950
+ */
4951
+ fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
4952
+ }[];
4953
+ /**
4954
+ Free text to match in searchable fields
4955
+ */
4956
+ search?: {
4957
+ /**
4958
+ Defines how separate search terms in `expression` are combined
4959
+ */
4960
+ mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
4961
+ /**
4962
+ Search term or expression
4963
+ @maxLength: 100
4964
+ */
4965
+ expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
4966
+ /**
4967
+ Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
4968
+ @maxLength: 200,
4969
+ @maxSize: 20
4970
+ */
4971
+ fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
4972
+ /**
4973
+ Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
4974
+ */
4975
+ fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
4976
+ };
4977
+ /**
4978
+ UTC offset or IANA time zone. Valid values are
4979
+ ISO 8601 UTC offsets, such as +02:00 or -06:00,
4980
+ and IANA time zone IDs, such as Europe/Rome
4981
+
4982
+ Affects all filters and aggregations returned values.
4983
+ You may override this behavior in a specific filter by providing
4984
+ timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
4985
+ @maxLength: 50
4986
+ */
4987
+ timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
4988
+ };
4743
4989
 
4744
- export { type CursorSearchPagingMethodOneOf as $, type V3PhysicalProperties as A, type V3WeightMeasurementUnitInfo as B, type CommonVideoResolution as C, type WeightUnitWithLiterals as D, InternalRowState as E, type InternalRowStateWithLiterals as F, type CursorQuery as G, type CursorQueryPagingMethodOneOf as H, type InternalMetadata as I, type Sorting as J, SortOrder as K, type SortOrderWithLiterals as L, MeasurementUnit as M, type CursorPaging as N, RequestedFields as O, ProductMediaMediaType as P, type QueryVariantsRequest as Q, type ReadOnlyVariant as R, SecuredMediaFileType as S, type RequestedFieldsWithLiterals as T, type QueryVariantsResponse as U, type V3OptionChoice as V, WeightUnit as W, type CursorPagingMetadata as X, type Cursors as Y, type SearchVariantsRequest as Z, type CursorSearch as _, type ReadOnlyVariantTypedPropertiesOneOf as a, type ValueAggregationSortDirectionWithLiterals as a$, type Aggregation as a0, type AggregationKindOneOf as a1, type RangeBucket as a2, SortType as a3, type SortTypeWithLiterals as a4, SortDirection as a5, type SortDirectionWithLiterals as a6, MissingValues as a7, type MissingValuesWithLiterals as a8, type IncludeMissingValuesOptions as a9, type RangeResults as aA, type AggregationResultsScalarResult as aB, type NestedValueAggregationResult as aC, type ValueResult as aD, type RangeResult as aE, type ScalarResult as aF, type NestedResultValue as aG, type NestedResultValueResultOneOf as aH, type Results as aI, type DateHistogramResult as aJ, type GroupByValueResults as aK, type DateHistogramResults as aL, type NestedResults as aM, type AggregationResults as aN, type AggregationResultsResultOneOf as aO, type DeprecatedSearchVariantsWithOffsetRequest as aP, type PlatformOffsetSearch as aQ, type PlatformOffsetSearchPagingMethodOneOf as aR, type CommonSorting as aS, CommonSortOrder as aT, type CommonSortOrderWithLiterals as aU, type CommonAggregation as aV, type CommonAggregationKindOneOf as aW, type RangeAggregationRangeBucket as aX, ValueAggregationSortType as aY, type ValueAggregationSortTypeWithLiterals as aZ, ValueAggregationSortDirection as a_, ScalarType as aa, type ScalarTypeWithLiterals as ab, type ValueAggregation as ac, type ValueAggregationOptionsOneOf as ad, NestedAggregationType as ae, type NestedAggregationTypeWithLiterals as af, type RangeAggregation as ag, type ScalarAggregation as ah, type DateHistogramAggregation as ai, Interval as aj, type IntervalWithLiterals as ak, type NestedAggregationItem as al, type NestedAggregationItemKindOneOf as am, AggregationType as an, type AggregationTypeWithLiterals as ao, type NestedAggregation as ap, type SearchDetails as aq, Mode as ar, type ModeWithLiterals as as, type SearchVariantsResponse as at, type AggregationData as au, type ValueAggregationResult as av, type RangeAggregationResult as aw, type NestedAggregationResults as ax, type NestedAggregationResultsResultOneOf as ay, type ValueResults as az, type V3OptionChoiceIds as b, Width as b$, ValueAggregationMissingValues as b0, type ValueAggregationMissingValuesWithLiterals as b1, type ValueAggregationIncludeMissingValuesOptions as b2, CommonScalarType as b3, type CommonScalarTypeWithLiterals as b4, type AggregationValueAggregation as b5, type AggregationValueAggregationOptionsOneOf as b6, NestedAggregationNestedAggregationType as b7, type NestedAggregationNestedAggregationTypeWithLiterals as b8, type AggregationRangeAggregation as b9, type ButtonData as bA, type Border as bB, type Colors as bC, type PluginContainerData as bD, WidthType as bE, type WidthTypeWithLiterals as bF, type PluginContainerDataWidth as bG, type PluginContainerDataWidthDataOneOf as bH, PluginContainerDataAlignment as bI, type PluginContainerDataAlignmentWithLiterals as bJ, type Spoiler as bK, type Height as bL, Type as bM, type TypeWithLiterals as bN, type Styles as bO, type Link as bP, type LinkDataOneOf as bQ, Target as bR, type TargetWithLiterals as bS, type Rel as bT, type CodeBlockData as bU, type TextStyle as bV, TextAlignment as bW, type TextAlignmentWithLiterals as bX, type DividerData as bY, LineStyle as bZ, type LineStyleWithLiterals as b_, type AggregationScalarAggregation as ba, type AggregationDateHistogramAggregation as bb, DateHistogramAggregationInterval as bc, type DateHistogramAggregationIntervalWithLiterals as bd, type NestedAggregationNestedAggregationItem as be, type NestedAggregationNestedAggregationItemKindOneOf as bf, CommonAggregationType as bg, type CommonAggregationTypeWithLiterals as bh, type AggregationNestedAggregation as bi, type GroupByAggregation as bj, type GroupByAggregationKindOneOf as bk, type CommonSearchDetails as bl, SearchDetailsMode as bm, type SearchDetailsModeWithLiterals as bn, type PlatformPaging as bo, type DeprecatedSearchVariantsWithOffsetResponse as bp, type PagingMetadata as bq, type MigrateProductVariantsRequest as br, type Product as bs, type ProductTypedPropertiesOneOf as bt, type RichContent as bu, type Node as bv, type NodeDataOneOf as bw, NodeType as bx, type NodeTypeWithLiterals as by, type NodeStyle as bz, type V3OptionChoiceNames as c, type BackgroundTypeWithLiterals as c$, type WidthWithLiterals as c0, Alignment as c1, type AlignmentWithLiterals as c2, type FileData as c3, ViewMode as c4, type ViewModeWithLiterals as c5, type FileSource as c6, type FileSourceDataOneOf as c7, type PDFSettings as c8, type GalleryData as c9, type ImageData as cA, type StylesBorder as cB, type ImageDataStyles as cC, type LinkPreviewData as cD, Position as cE, type PositionWithLiterals as cF, type LinkPreviewDataStyles as cG, type MapData as cH, type MapSettings as cI, MapType as cJ, type MapTypeWithLiterals as cK, type ParagraphData as cL, type PollData as cM, ViewRole as cN, type ViewRoleWithLiterals as cO, VoteRole as cP, type VoteRoleWithLiterals as cQ, type Permissions as cR, type Option as cS, type PollSettings as cT, PollLayoutType as cU, type PollLayoutTypeWithLiterals as cV, PollLayoutDirection as cW, type PollLayoutDirectionWithLiterals as cX, type PollLayout as cY, type OptionLayout as cZ, BackgroundType as c_, type V1Media as ca, type Image as cb, type Video as cc, type Item as cd, type ItemDataOneOf as ce, type GalleryOptions as cf, LayoutType as cg, type LayoutTypeWithLiterals as ch, Orientation as ci, type OrientationWithLiterals as cj, Crop as ck, type CropWithLiterals as cl, ThumbnailsAlignment as cm, type ThumbnailsAlignmentWithLiterals as cn, type Layout as co, type ItemStyle as cp, type Thumbnails as cq, type GIFData as cr, type GIF as cs, GIFType as ct, type GIFTypeWithLiterals as cu, type HeadingData as cv, type HTMLData as cw, type HTMLDataDataOneOf as cx, Source as cy, type SourceWithLiterals as cz, type V3PriceInfo as d, type Thumbnail as d$, type Gradient as d0, type Background as d1, type BackgroundBackgroundOneOf as d2, type PollDesign as d3, type OptionDesign as d4, type Poll as d5, type PollDataLayout as d6, type Design as d7, type TextData as d8, type Decoration as d9, type DirectionWithLiterals as dA, type TableData as dB, type Dimensions as dC, type TableCellData as dD, VerticalAlignment as dE, type VerticalAlignmentWithLiterals as dF, type CellStyle as dG, type BorderColors as dH, NullValue as dI, type NullValueWithLiterals as dJ, type ListValue as dK, type AudioData as dL, type OrderedListData as dM, type BulletedListData as dN, type BlockquoteData as dO, type CaptionData as dP, type LayoutCellData as dQ, type Metadata as dR, type DocumentStyle as dS, type TextNodeStyle as dT, type Media as dU, type ProductMedia as dV, type ProductMediaSetByOneOf as dW, type ProductMediaMediaOneOf as dX, type VideoResolution as dY, MediaType as dZ, type MediaTypeWithLiterals as d_, type DecorationDataOneOf as da, DecorationType as db, type DecorationTypeWithLiterals as dc, type AnchorData as dd, type ColorData as de, type LinkData as df, type MentionData as dg, type FontSizeData as dh, FontType as di, type FontTypeWithLiterals as dj, type SpoilerData as dk, type AppEmbedData as dl, type AppEmbedDataAppDataOneOf as dm, AppType as dn, type AppTypeWithLiterals as dp, type BookingData as dq, type EventData as dr, type VideoData as ds, type PlaybackOptions as dt, type EmbedData as du, type Oembed as dv, type CollapsibleListData as dw, InitialExpandedItems as dx, type InitialExpandedItemsWithLiterals as dy, Direction as dz, type V3FixedMonetaryAmount as e, type SubscriptionPrice as e$, type MediaItemsInfo as e0, type SeoSchema as e1, type Keyword as e2, type Tag as e3, type Settings as e4, type ConnectedOption as e5, type ConnectedOptionOptionSettingsOneOf as e6, ProductOptionRenderType as e7, type ProductOptionRenderTypeWithLiterals as e8, type ChoicesSettings as e9, ProductPreorderAvailability as eA, type ProductPreorderAvailabilityWithLiterals as eB, ProductType as eC, type ProductTypeWithLiterals as eD, type PhysicalProperties as eE, type PricePerUnitSettings as eF, type WeightRange as eG, type PricePerUnitRange as eH, type PricePerUnitRangePricePerUnit as eI, type WeightMeasurementUnitInfo as eJ, type BreadcrumbsInfo as eK, type BreadCrumb as eL, type VariantsInfo as eM, type Variant as eN, type VariantTypedPropertiesOneOf as eO, type OptionChoice as eP, type OptionChoiceIds as eQ, type OptionChoiceNames as eR, type PriceInfo as eS, type RevenueDetails as eT, type VariantPhysicalProperties as eU, type PricePerUnit as eV, type VariantDigitalProperties as eW, type SecuredMedia as eX, FileType as eY, type FileTypeWithLiterals as eZ, type SubscriptionPricesInfo as e_, type ConnectedOptionChoice as ea, type ConnectedOptionChoiceValueOneOf as eb, ChoiceType as ec, type ChoiceTypeWithLiterals as ed, type MultipleColors as ee, type ConnectedModifier as ef, type ConnectedModifierModifierSettingsOneOf as eg, ModifierRenderType as eh, type ModifierRenderTypeWithLiterals as ei, type FreeTextSettings as ej, type ModifierChoicesSettings as ek, type ConnectedModifierChoice as el, type ConnectedModifierChoiceValueOneOf as em, type Brand as en, type InfoSection as eo, type Ribbon as ep, type ProductCategoriesInfo as eq, type ProductCategory as er, type ProductCategoryIdsInfo as es, type PriceRange as et, type FixedMonetaryAmount as eu, type Inventory as ev, AvailabilityStatus as ew, type AvailabilityStatusWithLiterals as ex, PreorderStatus as ey, type PreorderStatusWithLiterals as ez, type V3RevenueDetails as f, type SubscriptionPricePerUnit as f0, type InventoryStatus as f1, type ExtendedFields as f2, type SubscriptionDetails as f3, type Subscription as f4, type SubscriptionCyclesOneOf as f5, SubscriptionFrequency as f6, type SubscriptionFrequencyWithLiterals as f7, type SubscriptionDiscount as f8, type SubscriptionDiscountDiscountOneOf as f9, DiscountType as fa, type DiscountTypeWithLiterals as fb, type VariantSummary as fc, type MinVariantPriceInfo as fd, type MigrateProductVariantsResponse as fe, type RecoverProductVariantsRequest as ff, type RecoverProductVariantsResponse as fg, type DomainEvent as fh, type DomainEventBodyOneOf as fi, type EntityCreatedEvent as fj, type RestoreInfo as fk, type EntityUpdatedEvent as fl, type EntityDeletedEvent as fm, type ActionEvent as fn, type Empty as fo, type MessageEnvelope as fp, type IdentificationData as fq, type IdentificationDataIdOneOf as fr, WebhookIdentityType as fs, type WebhookIdentityTypeWithLiterals as ft, type QueryVariantsOptions as fu, type VariantsQueryResult as fv, type VariantsQueryBuilder as fw, type SearchVariantsOptions as fx, type ReadOnlyVariantSearchSpec as fy, type CommonSearchWithEntityContext as fz, type V3ProductMedia as g, type V3ProductMediaSetByOneOf as h, type V3ProductMediaMediaOneOf as i, type ProductMediaMediaTypeWithLiterals as j, type V3Thumbnail as k, type V3VariantPhysicalProperties as l, type V3PricePerUnit as m, type V3PricePerUnitSettings as n, type MeasurementUnitWithLiterals as o, type V3VariantDigitalProperties as p, type V3SecuredMedia as q, type SecuredMediaFileTypeWithLiterals as r, type V3SubscriptionPricesInfo as s, type V3SubscriptionPrice as t, type V3SubscriptionPricePerUnit as u, type V3InventoryStatus as v, type ProductFields as w, type ProductFieldsTypedPropertiesOneOf as x, V3ProductType as y, type V3ProductTypeWithLiterals as z };
4990
+ 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 };