@wix/stores 1.0.311 → 1.0.313

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/stores",
3
- "version": "1.0.311",
3
+ "version": "1.0.313",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,17 +21,17 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/stores_brands-v-3": "1.0.29",
25
- "@wix/stores_catalog-versioning": "1.0.14",
26
- "@wix/stores_collections": "1.0.49",
27
- "@wix/stores_customizations-v-3": "1.0.31",
24
+ "@wix/stores_brands-v-3": "1.0.30",
25
+ "@wix/stores_catalog-versioning": "1.0.15",
26
+ "@wix/stores_collections": "1.0.50",
27
+ "@wix/stores_customizations-v-3": "1.0.32",
28
28
  "@wix/stores_info-sections-v-3": "1.0.31",
29
- "@wix/stores_inventory": "1.0.67",
30
- "@wix/stores_inventory-items-v-3": "1.0.36",
31
- "@wix/stores_products": "1.0.92",
32
- "@wix/stores_products-v-3": "1.0.79",
33
- "@wix/stores_ribbons-v-3": "1.0.25",
34
- "@wix/stores_stores-locations-v-3": "1.0.31",
29
+ "@wix/stores_inventory": "1.0.68",
30
+ "@wix/stores_inventory-items-v-3": "1.0.37",
31
+ "@wix/stores_products": "1.0.93",
32
+ "@wix/stores_products-v-3": "1.0.80",
33
+ "@wix/stores_ribbons-v-3": "1.0.26",
34
+ "@wix/stores_stores-locations-v-3": "1.0.32",
35
35
  "@wix/stores_subscription-options": "1.0.50",
36
36
  "@wix/stores_wishlist": "1.0.43"
37
37
  },
@@ -58,5 +58,5 @@
58
58
  "fqdn": ""
59
59
  }
60
60
  },
61
- "falconPackageHash": "8f67a5137b01d205ea2056f99853e642b3d47c5152e75928baf0d28e"
61
+ "falconPackageHash": "690648a22e481245c624807477b73946fd7eb1b781b1537edde0749b"
62
62
  }
@@ -732,10 +732,15 @@ interface MediaItemUrlAndSize$1 {
732
732
  }
733
733
  declare enum MediaItemType$1 {
734
734
  unspecified_media_item_type = "unspecified_media_item_type",
735
+ /** Image media type. */
735
736
  image = "image",
737
+ /** Video media type. */
736
738
  video = "video",
739
+ /** Audio media type. */
737
740
  audio = "audio",
741
+ /** Document media type. */
738
742
  document = "document",
743
+ /** Zip media type. */
739
744
  zip = "zip"
740
745
  }
741
746
  interface MediaItemVideo$1 {
@@ -1192,8 +1197,11 @@ interface Stock {
1192
1197
  inventoryStatus?: InventoryStatus$1;
1193
1198
  }
1194
1199
  declare enum InventoryStatus$1 {
1200
+ /** In stock */
1195
1201
  IN_STOCK = "IN_STOCK",
1202
+ /** Not in stock */
1196
1203
  OUT_OF_STOCK = "OUT_OF_STOCK",
1204
+ /** Some of the variants are not in stock */
1197
1205
  PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
1198
1206
  }
1199
1207
  interface PriceData {
@@ -1341,10 +1349,15 @@ interface MediaItemUrlAndSize {
1341
1349
  }
1342
1350
  declare enum MediaItemType {
1343
1351
  unspecified_media_item_type = "unspecified_media_item_type",
1352
+ /** Image media type. */
1344
1353
  image = "image",
1354
+ /** Video media type. */
1345
1355
  video = "video",
1356
+ /** Audio media type. */
1346
1357
  audio = "audio",
1358
+ /** Document media type. */
1347
1359
  document = "document",
1360
+ /** Zip media type. */
1348
1361
  zip = "zip"
1349
1362
  }
1350
1363
  interface MediaItemVideo {
@@ -1363,7 +1376,7 @@ interface CustomTextField {
1363
1376
  }
1364
1377
  interface ProductOption {
1365
1378
  /**
1366
- * Option type - color or other(drop down)
1379
+ * Option type.
1367
1380
  * @readonly
1368
1381
  */
1369
1382
  optionType?: OptionType;
@@ -1373,8 +1386,11 @@ interface ProductOption {
1373
1386
  choices?: Choice$1[];
1374
1387
  }
1375
1388
  declare enum OptionType {
1389
+ /** Unspecified option type. */
1376
1390
  unspecified_option_type = "unspecified_option_type",
1391
+ /** Drop down. */
1377
1392
  drop_down = "drop_down",
1393
+ /** Color. */
1378
1394
  color = "color"
1379
1395
  }
1380
1396
  interface Choice$1 {
@@ -1418,7 +1434,9 @@ declare enum DiscountType$2 {
1418
1434
  UNDEFINED = "UNDEFINED",
1419
1435
  /** No discount */
1420
1436
  NONE = "NONE",
1437
+ /** Discount by a fixed amount */
1421
1438
  AMOUNT = "AMOUNT",
1439
+ /** Discount by a percentage */
1422
1440
  PERCENT = "PERCENT"
1423
1441
  }
1424
1442
  interface Variant$1 {
@@ -2043,7 +2061,9 @@ interface ProductCreated {
2043
2061
  slug?: string;
2044
2062
  }
2045
2063
  declare enum Version$1 {
2064
+ /** Version 1 of the catalog. */
2046
2065
  V1_CATALOG = "V1_CATALOG",
2066
+ /** Version 3 of the catalog. */
2047
2067
  V3_CATALOG = "V3_CATALOG"
2048
2068
  }
2049
2069
  interface ProductChanged {
@@ -3799,7 +3819,9 @@ interface Sorting$6 {
3799
3819
  order?: SortOrder$6;
3800
3820
  }
3801
3821
  declare enum SortOrder$6 {
3822
+ /** Ascending order. */
3802
3823
  ASC = "ASC",
3824
+ /** Descending order. */
3803
3825
  DESC = "DESC"
3804
3826
  }
3805
3827
  interface CursorPaging$6 {
@@ -4708,9 +4730,13 @@ interface ChoiceValueOneOf {
4708
4730
  }
4709
4731
  declare enum ChoiceType$1 {
4710
4732
  UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
4733
+ /** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
4711
4734
  CHOICE_TEXT = "CHOICE_TEXT",
4735
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4712
4736
  ONE_COLOR = "ONE_COLOR",
4737
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4713
4738
  MULTIPLE_COLORS = "MULTIPLE_COLORS",
4739
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4714
4740
  IMAGE = "IMAGE"
4715
4741
  }
4716
4742
  interface MultipleColors$1 {
@@ -4804,7 +4830,9 @@ interface GetCustomizationRequest {
4804
4830
  fields?: RequestedFields$3[];
4805
4831
  }
4806
4832
  declare enum RequestedFields$3 {
4833
+ /** Unknown requested field. */
4807
4834
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
4835
+ /** Assigned products count. */
4808
4836
  ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
4809
4837
  }
4810
4838
  interface GetCustomizationResponse {
@@ -4871,7 +4899,9 @@ interface Sorting$5 {
4871
4899
  order?: SortOrder$5;
4872
4900
  }
4873
4901
  declare enum SortOrder$5 {
4902
+ /** Ascending order. */
4874
4903
  ASC = "ASC",
4904
+ /** Descending order. */
4875
4905
  DESC = "DESC"
4876
4906
  }
4877
4907
  interface CursorPaging$5 {
@@ -8392,14 +8422,11 @@ interface InventoryItemTrackingMethodOneOf$1 {
8392
8422
  }
8393
8423
  declare enum AvailabilityStatus$1 {
8394
8424
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
8425
+ /** Product is out of stock. */
8395
8426
  OUT_OF_STOCK = "OUT_OF_STOCK",
8427
+ /** Product is in stock. See `quantity` field for exact amount in stock. */
8396
8428
  IN_STOCK = "IN_STOCK",
8397
- /**
8398
- * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
8399
- * 1. the variant is out of stock
8400
- * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
8401
- * 3. preorder limit wasn't reached (preorder_setting.limit)
8402
- */
8429
+ /** Product is only available for preorder. See `preorderInfo` field for more info. */
8403
8430
  PREORDER = "PREORDER"
8404
8431
  }
8405
8432
  interface PreorderInfo$2 {
@@ -11842,7 +11869,9 @@ interface VideoResolution {
11842
11869
  }
11843
11870
  declare enum MediaType {
11844
11871
  UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
11872
+ /** Image media type. */
11845
11873
  IMAGE = "IMAGE",
11874
+ /** Video media type. */
11846
11875
  VIDEO = "VIDEO"
11847
11876
  }
11848
11877
  interface Thumbnail {
@@ -11927,8 +11956,11 @@ interface ConnectedOptionOptionSettingsOneOf {
11927
11956
  choicesSettings?: ChoicesSettings;
11928
11957
  }
11929
11958
  declare enum ProductOptionRenderType {
11959
+ /** Not implemented. */
11930
11960
  UNKNOWN_OPTION_RENDER_TYPE = "UNKNOWN_OPTION_RENDER_TYPE",
11961
+ /** Text choices. */
11931
11962
  TEXT_CHOICES = "TEXT_CHOICES",
11963
+ /** Swatch choices. */
11932
11964
  SWATCH_CHOICES = "SWATCH_CHOICES"
11933
11965
  }
11934
11966
  interface ChoicesSettings {
@@ -11971,9 +12003,13 @@ interface ConnectedOptionChoiceValueOneOf {
11971
12003
  }
11972
12004
  declare enum ChoiceType {
11973
12005
  UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
12006
+ /** Text choice. */
11974
12007
  CHOICE_TEXT = "CHOICE_TEXT",
12008
+ /** Single color choice. */
11975
12009
  ONE_COLOR = "ONE_COLOR",
12010
+ /** Multiple colors choice. */
11976
12011
  MULTIPLE_COLORS = "MULTIPLE_COLORS",
12012
+ /** Image choice. */
11977
12013
  IMAGE = "IMAGE"
11978
12014
  }
11979
12015
  interface MultipleColors {
@@ -12002,9 +12038,13 @@ interface ConnectedModifierModifierSettingsOneOf {
12002
12038
  choicesSettings?: ModifierChoicesSettings;
12003
12039
  }
12004
12040
  declare enum ModifierRenderType {
12041
+ /** Not implemented. */
12005
12042
  UNKNOWN_MODIFIER_RENDER_TYPE = "UNKNOWN_MODIFIER_RENDER_TYPE",
12043
+ /** Free text. */
12006
12044
  FREE_TEXT = "FREE_TEXT",
12045
+ /** Text choices. */
12007
12046
  TEXT_CHOICES = "TEXT_CHOICES",
12047
+ /** Swatch choices. */
12008
12048
  SWATCH_CHOICES = "SWATCH_CHOICES"
12009
12049
  }
12010
12050
  interface FreeTextSettings {
@@ -12129,52 +12169,53 @@ interface FixedMonetaryAmount {
12129
12169
  interface Inventory {
12130
12170
  /**
12131
12171
  * Current availability status.
12132
- *
12133
- * + `IN_STOCK`: All variants are in stock and available for purchase
12134
- * + `OUT_OF_STOCK`: All variants are out of stock
12135
- * + `PARTIALLY_OUT_OF_STOCK`: Some variants are out of stock and some are in stock and available for purchase
12136
12172
  * @readonly
12137
12173
  */
12138
12174
  availabilityStatus?: InventoryAvailabilityStatus;
12139
12175
  /**
12140
- * Current preorder status/
12141
- *
12142
- * + `ENABLED`: All variants are enabled for preorder
12143
- * + `DISABLED`: All variants are disabled for preorder
12144
- * + `PARTIALLY_ENABLED`: Some variants are disabled and some are enabled for preorder
12176
+ * Current preorder status.
12145
12177
  * @readonly
12146
12178
  */
12147
12179
  preorderStatus?: PreorderStatus;
12148
12180
  /**
12149
- * Supported values:
12150
- * + `ALL_VARIANTS`: All the product variants are available for preorder.
12151
- * + `NO_VARIANTS`: None of the product variants are available for preorder.
12152
- * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
12181
+ * Preorder availability status.
12153
12182
  * @readonly
12154
12183
  */
12155
12184
  preorderAvailability?: ProductPreorderAvailability;
12156
12185
  }
12157
12186
  declare enum InventoryAvailabilityStatus {
12158
12187
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
12188
+ /** All variants are in stock and available for purchase. */
12159
12189
  IN_STOCK = "IN_STOCK",
12190
+ /** All variants are out of stock. */
12160
12191
  OUT_OF_STOCK = "OUT_OF_STOCK",
12192
+ /** Some variants are out of stock and some are in stock and available for purchase. */
12161
12193
  PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
12162
12194
  }
12163
12195
  declare enum PreorderStatus {
12164
12196
  UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
12197
+ /** All variants are enabled for preorder. */
12165
12198
  ENABLED = "ENABLED",
12199
+ /** All variants are disabled for preorder. */
12166
12200
  DISABLED = "DISABLED",
12201
+ /** Some variants are disabled and some are enabled for preorder. */
12167
12202
  PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
12168
12203
  }
12169
12204
  declare enum ProductPreorderAvailability {
12170
12205
  UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
12206
+ /** All the product variants are available for preorder. */
12171
12207
  ALL_VARIANTS = "ALL_VARIANTS",
12208
+ /** None of the product variants are available for preorder. */
12172
12209
  NO_VARIANTS = "NO_VARIANTS",
12210
+ /** Some of the product variants are available for preorder. */
12173
12211
  SOME_VARIANTS = "SOME_VARIANTS"
12174
12212
  }
12175
12213
  declare enum ProductType {
12214
+ /** Not implemented. */
12176
12215
  UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
12216
+ /** Physical product. */
12177
12217
  PHYSICAL = "PHYSICAL",
12218
+ /** Digital product. */
12178
12219
  DIGITAL = "DIGITAL"
12179
12220
  }
12180
12221
  interface PhysicalProperties {
@@ -12448,11 +12489,17 @@ interface SecuredMedia {
12448
12489
  fileType?: FileType;
12449
12490
  }
12450
12491
  declare enum FileType {
12492
+ /** Unspecified file type. */
12451
12493
  UNSPECIFIED = "UNSPECIFIED",
12494
+ /** Secure picture file. */
12452
12495
  SECURE_PICTURE = "SECURE_PICTURE",
12496
+ /** Secure video file. */
12453
12497
  SECURE_VIDEO = "SECURE_VIDEO",
12498
+ /** Secure document file. */
12454
12499
  SECURE_DOCUMENT = "SECURE_DOCUMENT",
12500
+ /** Secure music file. */
12455
12501
  SECURE_MUSIC = "SECURE_MUSIC",
12502
+ /** Secure archive file. */
12456
12503
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
12457
12504
  }
12458
12505
  interface SubscriptionPricesInfo {
@@ -12578,7 +12625,9 @@ interface SubscriptionDiscountDiscountOneOf {
12578
12625
  }
12579
12626
  declare enum DiscountType$1 {
12580
12627
  UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT",
12628
+ /** Discount by a specific amount. */
12581
12629
  AMOUNT = "AMOUNT",
12630
+ /** Discount by a percentage. */
12582
12631
  PERCENT = "PERCENT"
12583
12632
  }
12584
12633
  interface VariantSummary {
@@ -12874,11 +12923,12 @@ interface CreateProductRequest {
12874
12923
  fields?: SingleEntityOpsRequestedFields[];
12875
12924
  }
12876
12925
  declare enum SingleEntityOpsRequestedFields {
12926
+ /** Not implemented. */
12877
12927
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
12878
12928
  URL = "URL",
12879
12929
  CURRENCY = "CURRENCY",
12880
12930
  INFO_SECTION = "INFO_SECTION",
12881
- /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
12931
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
12882
12932
  MERCHANT_DATA = "MERCHANT_DATA",
12883
12933
  PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
12884
12934
  INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -13325,14 +13375,11 @@ interface InventoryItemTrackingMethodOneOf {
13325
13375
  }
13326
13376
  declare enum AvailabilityStatus {
13327
13377
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
13378
+ /** Product is out of stock. */
13328
13379
  OUT_OF_STOCK = "OUT_OF_STOCK",
13380
+ /** Product is in stock. See `quantity` field for exact amount in stock. */
13329
13381
  IN_STOCK = "IN_STOCK",
13330
- /**
13331
- * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
13332
- * 1. the variant is out of stock
13333
- * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
13334
- * 3. preorder limit wasn't reached (preorder_setting.limit)
13335
- */
13382
+ /** Product is only available for preorder. See `preorderInfo` field for more info. */
13336
13383
  PREORDER = "PREORDER"
13337
13384
  }
13338
13385
  interface Product {
@@ -13400,11 +13447,12 @@ interface BulkCreateProductsRequest {
13400
13447
  fields?: RequestedFields$1[];
13401
13448
  }
13402
13449
  declare enum RequestedFields$1 {
13450
+ /** Not implemented. */
13403
13451
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
13404
13452
  URL = "URL",
13405
13453
  CURRENCY = "CURRENCY",
13406
13454
  INFO_SECTION = "INFO_SECTION",
13407
- /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
13455
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
13408
13456
  MERCHANT_DATA = "MERCHANT_DATA",
13409
13457
  PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
13410
13458
  INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -14478,7 +14526,9 @@ interface Sorting$2 {
14478
14526
  order?: SortOrder$2;
14479
14527
  }
14480
14528
  declare enum SortOrder$2 {
14529
+ /** Ascending order. */
14481
14530
  ASC = "ASC",
14531
+ /** Descending order. */
14482
14532
  DESC = "DESC"
14483
14533
  }
14484
14534
  interface Aggregation extends AggregationKindOneOf {
@@ -14519,21 +14569,21 @@ interface RangeBucket {
14519
14569
  to?: number | null;
14520
14570
  }
14521
14571
  declare enum SortType {
14522
- /** Should sort by number of matches */
14572
+ /** Should sort by number of matches. */
14523
14573
  COUNT = "COUNT",
14524
- /** Should sort by value of the field alphabetically */
14574
+ /** Should sort by value of the field alphabetically. */
14525
14575
  VALUE = "VALUE"
14526
14576
  }
14527
14577
  declare enum SortDirection {
14528
- /** Should sort in descending order */
14578
+ /** Should sort by descending order. */
14529
14579
  DESC = "DESC",
14530
- /** Should sort in ascending order */
14580
+ /** Should sort by ascending order. */
14531
14581
  ASC = "ASC"
14532
14582
  }
14533
14583
  declare enum MissingValues {
14534
- /** Should missing values be excluded from the aggregation results */
14584
+ /** Exclude missing values from the aggregation results. */
14535
14585
  EXCLUDE = "EXCLUDE",
14536
- /** Should missing values be included in the aggregation results */
14586
+ /** Include missing values from the aggregation results. */
14537
14587
  INCLUDE = "INCLUDE"
14538
14588
  }
14539
14589
  interface IncludeMissingValuesOptions {
@@ -14541,16 +14591,17 @@ interface IncludeMissingValuesOptions {
14541
14591
  addToBucket?: string;
14542
14592
  }
14543
14593
  declare enum ScalarType {
14594
+ /** Undefined scalar type. */
14544
14595
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
14545
- /** Count of distinct values */
14596
+ /** Count of distinct values. */
14546
14597
  COUNT_DISTINCT = "COUNT_DISTINCT",
14547
- /** Minimum value */
14598
+ /** Minimum value. */
14548
14599
  MIN = "MIN",
14549
- /** Maximum value */
14600
+ /** Maximum value. */
14550
14601
  MAX = "MAX",
14551
- /** Sum of values */
14602
+ /** Sum of values. */
14552
14603
  SUM = "SUM",
14553
- /** Average of values */
14604
+ /** Average of values. */
14554
14605
  AVG = "AVG"
14555
14606
  }
14556
14607
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
@@ -14571,14 +14622,15 @@ interface ValueAggregationOptionsOneOf {
14571
14622
  includeOptions?: IncludeMissingValuesOptions;
14572
14623
  }
14573
14624
  declare enum NestedAggregationType {
14625
+ /** Undefined nested aggregation type. */
14574
14626
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
14575
- /** An aggregation where result buckets are dynamically built - one per unique value */
14627
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
14576
14628
  VALUE = "VALUE",
14577
- /** An aggregation, where user can define set of ranges - each representing a bucket */
14629
+ /** An aggregation where user can define set of ranges - each representing a bucket. */
14578
14630
  RANGE = "RANGE",
14579
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
14631
+ /** A single-value metric aggregation. For example: min, max, sum, avg. */
14580
14632
  SCALAR = "SCALAR",
14581
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
14633
+ /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
14582
14634
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
14583
14635
  }
14584
14636
  interface RangeAggregation {
@@ -14594,20 +14646,21 @@ interface DateHistogramAggregation {
14594
14646
  interval?: Interval;
14595
14647
  }
14596
14648
  declare enum Interval {
14649
+ /** Undefined interval type. */
14597
14650
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
14598
- /** Yearly interval */
14651
+ /** Yearly interval. */
14599
14652
  YEAR = "YEAR",
14600
- /** Monthly interval */
14653
+ /** Monthly interval. */
14601
14654
  MONTH = "MONTH",
14602
- /** Weekly interval */
14655
+ /** Weekly interval. */
14603
14656
  WEEK = "WEEK",
14604
- /** Daily interval */
14657
+ /** Daily interval. */
14605
14658
  DAY = "DAY",
14606
- /** Hourly interval */
14659
+ /** Hourly interval. */
14607
14660
  HOUR = "HOUR",
14608
- /** Minute interval */
14661
+ /** Minute interval. */
14609
14662
  MINUTE = "MINUTE",
14610
- /** Second interval */
14663
+ /** Second interval. */
14611
14664
  SECOND = "SECOND"
14612
14665
  }
14613
14666
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -14638,16 +14691,17 @@ interface NestedAggregationItemKindOneOf {
14638
14691
  dateHistogram?: DateHistogramAggregation;
14639
14692
  }
14640
14693
  declare enum AggregationType {
14694
+ /** Undefined aggregation type. */
14641
14695
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
14642
- /** An aggregation where result buckets are dynamically built - one per unique value */
14696
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
14643
14697
  VALUE = "VALUE",
14644
- /** An aggregation, where user can define set of ranges - each representing a bucket */
14698
+ /** An aggregation where a user can define set of ranges - each representing a bucket. */
14645
14699
  RANGE = "RANGE",
14646
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
14700
+ /** A single-value metric aggregation. For example: min, max, sum, avg. */
14647
14701
  SCALAR = "SCALAR",
14648
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
14702
+ /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
14649
14703
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
14650
- /** Multi-level aggregation, where each next aggregation is nested within previous one */
14704
+ /** A Multi-level aggregation where each next aggregation is nested within previous one. */
14651
14705
  NESTED = "NESTED"
14652
14706
  }
14653
14707
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
@@ -14656,7 +14710,7 @@ interface NestedAggregation {
14656
14710
  nestedAggregations?: NestedAggregationItem[];
14657
14711
  }
14658
14712
  interface SearchDetails {
14659
- /** Defines how separate search terms in `expression` are combined */
14713
+ /** Defines how separate search terms in `expression` are combined. */
14660
14714
  mode?: Mode;
14661
14715
  /** Search term or expression */
14662
14716
  expression?: string | null;
@@ -14666,9 +14720,9 @@ interface SearchDetails {
14666
14720
  fuzzy?: boolean;
14667
14721
  }
14668
14722
  declare enum Mode {
14669
- /** Any of the search terms must be present */
14723
+ /** Any of the search terms must be present. */
14670
14724
  OR = "OR",
14671
- /** All search terms must be present */
14725
+ /** All search terms must be present. */
14672
14726
  AND = "AND"
14673
14727
  }
14674
14728
  interface CursorPaging$2 {
@@ -15252,9 +15306,10 @@ interface VariantsCursorPaging {
15252
15306
  cursor?: string | null;
15253
15307
  }
15254
15308
  declare enum VariantsOpsRequestedFields {
15309
+ /** Not implemented. */
15255
15310
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
15256
15311
  CURRENCY = "CURRENCY",
15257
- /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
15312
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
15258
15313
  MERCHANT_DATA = "MERCHANT_DATA",
15259
15314
  SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
15260
15315
  VARIANT_OPTION_CHOICE_NAMES = "VARIANT_OPTION_CHOICE_NAMES",
@@ -15567,20 +15622,21 @@ interface UnsignedAdjustValueAdjustValueOneOf {
15567
15622
  percentage?: number;
15568
15623
  }
15569
15624
  declare enum RoundingStrategy {
15625
+ /** Undefined rounding strategy. */
15570
15626
  UNKNOWN_ROUNDING_STRATEGY = "UNKNOWN_ROUNDING_STRATEGY",
15571
15627
  /**
15572
- * Calculated prices will be saved without rounding to keep max possible precision. It's still good idea to round numbers before displaying them.
15573
- * Example: input $3.5555 -> saved value $3.5555
15628
+ * Calculated prices are saved without rounding to keep the maximum possible precision. It's a good idea to round numbers before displaying them.
15629
+ * For example, input $3.5555 -> saved value $3.5555
15574
15630
  */
15575
15631
  NO_ROUNDING = "NO_ROUNDING",
15576
15632
  /**
15577
- * Calculated prices will be rounded according to currency precision.
15578
- * Example: input $3.5555 -> saved value $3.56, input ¥3.5555 -> saved value ¥4
15633
+ * Calculated prices are rounded according to currency precision.
15634
+ * For example:, input $3.5555 -> saved value $3.56, input ¥3.5555 -> saved value ¥4
15579
15635
  */
15580
15636
  CURRENCY_PRECISION = "CURRENCY_PRECISION",
15581
15637
  /**
15582
- * Calculated prices will be rounded to nearest whole number.
15583
- * Example: input $3.5555 -> saved value $4
15638
+ * Calculated prices are rounded to nearest whole number.
15639
+ * For example, input $3.5555 -> saved value $4
15584
15640
  */
15585
15641
  NEAREST_WHOLE_NUMBER = "NEAREST_WHOLE_NUMBER"
15586
15642
  }
@@ -17974,7 +18030,9 @@ interface Provision {
17974
18030
  catalogVersion?: Version;
17975
18031
  }
17976
18032
  declare enum Version {
18033
+ /** Version 1 of the catalog. */
17977
18034
  V1_CATALOG = "V1_CATALOG",
18035
+ /** Version 3 of the catalog. */
17978
18036
  V3_CATALOG = "V3_CATALOG"
17979
18037
  }
17980
18038
  interface DefaultDeliveryProfileSetup {
@@ -18190,7 +18248,9 @@ declare enum Namespace {
18190
18248
  */
18191
18249
  UGC_TEMPLATE = "UGC_TEMPLATE",
18192
18250
  /** Codux Headless Sites */
18193
- CODUX = "CODUX"
18251
+ CODUX = "CODUX",
18252
+ /** Bobb - AI Design Creator. */
18253
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR"
18194
18254
  }
18195
18255
  /** Site transferred to another user. */
18196
18256
  interface SiteTransferred {
@@ -18560,7 +18620,9 @@ interface Sorting$1 {
18560
18620
  order?: SortOrder$1;
18561
18621
  }
18562
18622
  declare enum SortOrder$1 {
18623
+ /** Ascending order. */
18563
18624
  ASC = "ASC",
18625
+ /** Descending order. */
18564
18626
  DESC = "DESC"
18565
18627
  }
18566
18628
  interface CursorPaging$1 {
@@ -19365,9 +19427,6 @@ interface StoresLocation {
19365
19427
  wixLocationId?: string | null;
19366
19428
  /**
19367
19429
  * Location type.
19368
- *
19369
- * + `VIRTUAL`: Online store.
19370
- * + `PHYSICAL`: Physical location. For example, for POS.
19371
19430
  * @readonly
19372
19431
  */
19373
19432
  locationType?: LocationType;
@@ -19381,9 +19440,9 @@ interface StoresLocation {
19381
19440
  }
19382
19441
  declare enum LocationType {
19383
19442
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
19384
- /** Online stores location. */
19443
+ /** Online store. */
19385
19444
  VIRTUAL = "VIRTUAL",
19386
- /** Physical location like POS */
19445
+ /** Physical location, for example, POS. */
19387
19446
  PHYSICAL = "PHYSICAL"
19388
19447
  }
19389
19448
  interface InvalidateCache extends InvalidateCacheGetByOneOf {
@@ -20574,9 +20633,13 @@ interface ChangedInventoryVariantData {
20574
20633
  availableForPreorder?: boolean;
20575
20634
  }
20576
20635
  declare enum ReasonType {
20636
+ /** Unknown reason. */
20577
20637
  UNKNOWN = "UNKNOWN",
20638
+ /** Order related. */
20578
20639
  ORDER = "ORDER",
20640
+ /** Manual adjustment. */
20579
20641
  MANUAL = "MANUAL",
20642
+ /** Reverting an inventory change. */
20580
20643
  REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE"
20581
20644
  }
20582
20645
  interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {