@wix/stores 1.0.310 → 1.0.312

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.
@@ -1446,7 +1446,7 @@ interface BulkAdjustProductPropertiesResponse$1 {
1446
1446
  /** Bulk action metadata. */
1447
1447
  bulkActionMetadata?: BulkActionMetadata$b;
1448
1448
  }
1449
- interface Paging$5 {
1449
+ interface Paging$7 {
1450
1450
  /** Amount of items to load per page */
1451
1451
  limit?: number | null;
1452
1452
  /** Number of items to skip in the display (relevant for all pages after the first) */
@@ -1588,7 +1588,7 @@ interface QueryProductVariantsRequest$1 {
1588
1588
  choices?: Record<string, string>;
1589
1589
  /** List of variant IDs (not relevant when passing choices). */
1590
1590
  variantIds?: string[];
1591
- paging?: Paging$5;
1591
+ paging?: Paging$7;
1592
1592
  /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
1593
1593
  includeMerchantSpecificData?: boolean;
1594
1594
  }
@@ -2850,7 +2850,7 @@ interface BulkAdjustProductPropertiesResponse {
2850
2850
  /** Bulk action metadata. */
2851
2851
  bulkActionMetadata?: BulkActionMetadata$a;
2852
2852
  }
2853
- interface Paging$4 {
2853
+ interface Paging$6 {
2854
2854
  /** Amount of items to load per page */
2855
2855
  limit?: number | null;
2856
2856
  /** Number of items to skip in the display (relevant for all pages after the first) */
@@ -2992,7 +2992,7 @@ interface QueryProductVariantsRequest {
2992
2992
  choices?: Record<string, string>;
2993
2993
  /** List of variant IDs (not relevant when passing choices). */
2994
2994
  variantIds?: string[];
2995
- paging?: Paging$4;
2995
+ paging?: Paging$6;
2996
2996
  /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
2997
2997
  includeMerchantSpecificData?: boolean;
2998
2998
  }
@@ -3551,7 +3551,9 @@ interface Sorting$b {
3551
3551
  order?: SortOrder$b;
3552
3552
  }
3553
3553
  declare enum SortOrder$b {
3554
+ /** Ascending order. */
3554
3555
  ASC = "ASC",
3556
+ /** Descending order. */
3555
3557
  DESC = "DESC"
3556
3558
  }
3557
3559
  interface CursorPaging$b {
@@ -3895,7 +3897,9 @@ interface Sorting$a {
3895
3897
  order?: SortOrder$a;
3896
3898
  }
3897
3899
  declare enum SortOrder$a {
3900
+ /** Ascending order. */
3898
3901
  ASC = "ASC",
3902
+ /** Descending order. */
3899
3903
  DESC = "DESC"
3900
3904
  }
3901
3905
  interface CursorPaging$a {
@@ -4289,9 +4293,13 @@ interface ChoiceValueOneOf$1 {
4289
4293
  }
4290
4294
  declare enum ChoiceType$3 {
4291
4295
  UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
4296
+ /** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
4292
4297
  CHOICE_TEXT = "CHOICE_TEXT",
4298
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4293
4299
  ONE_COLOR = "ONE_COLOR",
4300
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4294
4301
  MULTIPLE_COLORS = "MULTIPLE_COLORS",
4302
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4295
4303
  IMAGE = "IMAGE"
4296
4304
  }
4297
4305
  interface CreateCustomizationRequest$1 {
@@ -4313,7 +4321,9 @@ interface GetCustomizationRequest$1 {
4313
4321
  fields?: RequestedFields$7[];
4314
4322
  }
4315
4323
  declare enum RequestedFields$7 {
4324
+ /** Unknown requested field. */
4316
4325
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
4326
+ /** Assigned products count. */
4317
4327
  ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
4318
4328
  }
4319
4329
  interface GetCustomizationResponse$1 {
@@ -4380,7 +4390,9 @@ interface Sorting$9 {
4380
4390
  order?: SortOrder$9;
4381
4391
  }
4382
4392
  declare enum SortOrder$9 {
4393
+ /** Ascending order. */
4383
4394
  ASC = "ASC",
4395
+ /** Descending order. */
4384
4396
  DESC = "DESC"
4385
4397
  }
4386
4398
  interface CursorPaging$9 {
@@ -4801,9 +4813,13 @@ interface ChoiceValueOneOf {
4801
4813
  }
4802
4814
  declare enum ChoiceType$2 {
4803
4815
  UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
4816
+ /** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
4804
4817
  CHOICE_TEXT = "CHOICE_TEXT",
4818
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4805
4819
  ONE_COLOR = "ONE_COLOR",
4820
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4806
4821
  MULTIPLE_COLORS = "MULTIPLE_COLORS",
4822
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
4807
4823
  IMAGE = "IMAGE"
4808
4824
  }
4809
4825
  interface CreateCustomizationRequest {
@@ -4825,7 +4841,9 @@ interface GetCustomizationRequest {
4825
4841
  fields?: RequestedFields$6[];
4826
4842
  }
4827
4843
  declare enum RequestedFields$6 {
4844
+ /** Unknown requested field. */
4828
4845
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
4846
+ /** Assigned products count. */
4829
4847
  ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
4830
4848
  }
4831
4849
  interface GetCustomizationResponse {
@@ -4892,7 +4910,9 @@ interface Sorting$8 {
4892
4910
  order?: SortOrder$8;
4893
4911
  }
4894
4912
  declare enum SortOrder$8 {
4913
+ /** Ascending order. */
4895
4914
  ASC = "ASC",
4915
+ /** Descending order. */
4896
4916
  DESC = "DESC"
4897
4917
  }
4898
4918
  interface CursorPaging$8 {
@@ -9086,14 +9106,11 @@ interface InventoryItemTrackingMethodOneOf$3 {
9086
9106
  }
9087
9107
  declare enum AvailabilityStatus$3 {
9088
9108
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
9109
+ /** Product is out of stock. */
9089
9110
  OUT_OF_STOCK = "OUT_OF_STOCK",
9111
+ /** Product is in stock. See `quantity` field for exact amount in stock. */
9090
9112
  IN_STOCK = "IN_STOCK",
9091
- /**
9092
- * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
9093
- * 1. the variant is out of stock
9094
- * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
9095
- * 3. preorder limit wasn't reached (preorder_setting.limit)
9096
- */
9113
+ /** Product is only available for preorder. See `preorderInfo` field for more info. */
9097
9114
  PREORDER = "PREORDER"
9098
9115
  }
9099
9116
  interface PreorderInfo$5 {
@@ -9311,34 +9328,32 @@ interface BulkInventoryItemResult$3 {
9311
9328
  }
9312
9329
  interface QueryInventoryItemsRequest$1 {
9313
9330
  /** Query options. */
9314
- query?: InventoryQuery$1;
9331
+ query?: QueryV2$1;
9315
9332
  }
9316
- interface InventoryQuery$1 extends InventoryQueryPagingMethodOneOf$1 {
9317
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
9318
- paging?: InventoryPaging$1;
9319
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
9320
- cursorPaging?: InventoryCursorPaging$1;
9333
+ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
9334
+ /** Paging options to limit and skip the number of items. */
9335
+ paging?: Paging$5;
9336
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
9337
+ cursorPaging?: CursorPaging$5;
9321
9338
  /**
9322
- * Filter object in the following format:
9323
- * `"filter" : {
9324
- * "fieldName1": "value1",
9325
- * "fieldName2":{"$operator":"value2"}
9326
- * }`
9327
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
9339
+ * Filter object.
9340
+ *
9341
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
9328
9342
  */
9329
9343
  filter?: Record<string, any> | null;
9330
9344
  /**
9331
- * Sort object in the following format:
9332
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
9345
+ * Sort object.
9346
+ *
9347
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
9333
9348
  */
9334
9349
  sort?: Sorting$5[];
9335
9350
  }
9336
9351
  /** @oneof */
9337
- interface InventoryQueryPagingMethodOneOf$1 {
9338
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
9339
- paging?: InventoryPaging$1;
9340
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
9341
- cursorPaging?: InventoryCursorPaging$1;
9352
+ interface QueryV2PagingMethodOneOf$1 {
9353
+ /** Paging options to limit and skip the number of items. */
9354
+ paging?: Paging$5;
9355
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
9356
+ cursorPaging?: CursorPaging$5;
9342
9357
  }
9343
9358
  interface Sorting$5 {
9344
9359
  /** Name of the field to sort by. */
@@ -9350,22 +9365,19 @@ declare enum SortOrder$5 {
9350
9365
  ASC = "ASC",
9351
9366
  DESC = "DESC"
9352
9367
  }
9353
- interface InventoryPaging$1 {
9368
+ interface Paging$5 {
9354
9369
  /** Number of items to load. */
9355
9370
  limit?: number | null;
9356
9371
  /** Number of items to skip in the current sort order. */
9357
9372
  offset?: number | null;
9358
9373
  }
9359
- interface InventoryCursorPaging$1 {
9360
- /**
9361
- * Number of items to load.
9362
- * Cursor token returned in the query response. To be used on the next query request, but not the first query request.
9363
- */
9374
+ interface CursorPaging$5 {
9375
+ /** Maximum number of items to return in the results. */
9364
9376
  limit?: number | null;
9365
9377
  /**
9366
9378
  * Pointer to the next or previous page in the list of results.
9367
- * You can get the relevant cursor token
9368
- * from the `pagingMetadata` object in the previous call's response.
9379
+ *
9380
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
9369
9381
  * Not relevant for the first request.
9370
9382
  */
9371
9383
  cursor?: string | null;
@@ -9380,9 +9392,9 @@ interface PlatformPagingMetadataV2$1 {
9380
9392
  /** The number of items returned in this response. */
9381
9393
  count?: number | null;
9382
9394
  /** Cursors to navigate through result pages. Returned if cursor paging was used. */
9383
- cursors?: Cursors$5;
9395
+ cursors?: CommonCursors$3;
9384
9396
  }
9385
- interface Cursors$5 {
9397
+ interface CommonCursors$3 {
9386
9398
  /** Cursor string pointing to the next page in the list of results. */
9387
9399
  next?: string | null;
9388
9400
  /** Cursor pointing to the previous page in the list of results. */
@@ -9629,17 +9641,6 @@ interface GroupByAggregationKindOneOf$1 {
9629
9641
  /** Value aggregation configuration. */
9630
9642
  value?: ValueAggregation$1;
9631
9643
  }
9632
- interface CursorPaging$5 {
9633
- /** Maximum number of items to return in the results. */
9634
- limit?: number | null;
9635
- /**
9636
- * Pointer to the next or previous page in the list of results.
9637
- *
9638
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
9639
- * Not relevant for the first request.
9640
- */
9641
- cursor?: string | null;
9642
- }
9643
9644
  interface SearchInventoryItemsResponse$1 {
9644
9645
  /** List of inventory items. */
9645
9646
  inventoryItems?: InventoryItem$3[];
@@ -9661,6 +9662,12 @@ interface CursorPagingMetadata$5 {
9661
9662
  */
9662
9663
  hasNext?: boolean | null;
9663
9664
  }
9665
+ interface Cursors$5 {
9666
+ /** Cursor string pointing to the next page in the list of results. */
9667
+ next?: string | null;
9668
+ /** Cursor pointing to the previous page in the list of results. */
9669
+ prev?: string | null;
9670
+ }
9664
9671
  interface AggregationData$1 {
9665
9672
  /** key = aggregation name (as derived from search request). */
9666
9673
  results?: AggregationResults$1[];
@@ -10171,14 +10178,11 @@ interface InventoryItemTrackingMethodOneOf$2 {
10171
10178
  }
10172
10179
  declare enum AvailabilityStatus$2 {
10173
10180
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
10181
+ /** Product is out of stock. */
10174
10182
  OUT_OF_STOCK = "OUT_OF_STOCK",
10183
+ /** Product is in stock. See `quantity` field for exact amount in stock. */
10175
10184
  IN_STOCK = "IN_STOCK",
10176
- /**
10177
- * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
10178
- * 1. the variant is out of stock
10179
- * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
10180
- * 3. preorder limit wasn't reached (preorder_setting.limit)
10181
- */
10185
+ /** Product is only available for preorder. See `preorderInfo` field for more info. */
10182
10186
  PREORDER = "PREORDER"
10183
10187
  }
10184
10188
  interface PreorderInfo$4 {
@@ -10396,34 +10400,32 @@ interface BulkInventoryItemResult$2 {
10396
10400
  }
10397
10401
  interface QueryInventoryItemsRequest {
10398
10402
  /** Query options. */
10399
- query?: InventoryQuery;
10403
+ query?: QueryV2;
10400
10404
  }
10401
- interface InventoryQuery extends InventoryQueryPagingMethodOneOf {
10402
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
10403
- paging?: InventoryPaging;
10404
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
10405
- cursorPaging?: InventoryCursorPaging;
10405
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
10406
+ /** Paging options to limit and skip the number of items. */
10407
+ paging?: Paging$4;
10408
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
10409
+ cursorPaging?: CursorPaging$4;
10406
10410
  /**
10407
- * Filter object in the following format:
10408
- * `"filter" : {
10409
- * "fieldName1": "value1",
10410
- * "fieldName2":{"$operator":"value2"}
10411
- * }`
10412
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
10411
+ * Filter object.
10412
+ *
10413
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
10413
10414
  */
10414
10415
  filter?: Record<string, any> | null;
10415
10416
  /**
10416
- * Sort object in the following format:
10417
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
10417
+ * Sort object.
10418
+ *
10419
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
10418
10420
  */
10419
10421
  sort?: Sorting$4[];
10420
10422
  }
10421
10423
  /** @oneof */
10422
- interface InventoryQueryPagingMethodOneOf {
10423
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
10424
- paging?: InventoryPaging;
10425
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
10426
- cursorPaging?: InventoryCursorPaging;
10424
+ interface QueryV2PagingMethodOneOf {
10425
+ /** Paging options to limit and skip the number of items. */
10426
+ paging?: Paging$4;
10427
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
10428
+ cursorPaging?: CursorPaging$4;
10427
10429
  }
10428
10430
  interface Sorting$4 {
10429
10431
  /** Name of the field to sort by. */
@@ -10435,22 +10437,19 @@ declare enum SortOrder$4 {
10435
10437
  ASC = "ASC",
10436
10438
  DESC = "DESC"
10437
10439
  }
10438
- interface InventoryPaging {
10440
+ interface Paging$4 {
10439
10441
  /** Number of items to load. */
10440
10442
  limit?: number | null;
10441
10443
  /** Number of items to skip in the current sort order. */
10442
10444
  offset?: number | null;
10443
10445
  }
10444
- interface InventoryCursorPaging {
10445
- /**
10446
- * Number of items to load.
10447
- * Cursor token returned in the query response. To be used on the next query request, but not the first query request.
10448
- */
10446
+ interface CursorPaging$4 {
10447
+ /** Maximum number of items to return in the results. */
10449
10448
  limit?: number | null;
10450
10449
  /**
10451
10450
  * Pointer to the next or previous page in the list of results.
10452
- * You can get the relevant cursor token
10453
- * from the `pagingMetadata` object in the previous call's response.
10451
+ *
10452
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
10454
10453
  * Not relevant for the first request.
10455
10454
  */
10456
10455
  cursor?: string | null;
@@ -10465,9 +10464,9 @@ interface PlatformPagingMetadataV2 {
10465
10464
  /** The number of items returned in this response. */
10466
10465
  count?: number | null;
10467
10466
  /** Cursors to navigate through result pages. Returned if cursor paging was used. */
10468
- cursors?: Cursors$4;
10467
+ cursors?: CommonCursors$2;
10469
10468
  }
10470
- interface Cursors$4 {
10469
+ interface CommonCursors$2 {
10471
10470
  /** Cursor string pointing to the next page in the list of results. */
10472
10471
  next?: string | null;
10473
10472
  /** Cursor pointing to the previous page in the list of results. */
@@ -10714,17 +10713,6 @@ interface GroupByAggregationKindOneOf {
10714
10713
  /** Value aggregation configuration. */
10715
10714
  value?: ValueAggregation;
10716
10715
  }
10717
- interface CursorPaging$4 {
10718
- /** Maximum number of items to return in the results. */
10719
- limit?: number | null;
10720
- /**
10721
- * Pointer to the next or previous page in the list of results.
10722
- *
10723
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
10724
- * Not relevant for the first request.
10725
- */
10726
- cursor?: string | null;
10727
- }
10728
10716
  interface SearchInventoryItemsResponse {
10729
10717
  /** List of inventory items. */
10730
10718
  inventoryItems?: InventoryItem$2[];
@@ -10746,6 +10734,12 @@ interface CursorPagingMetadata$4 {
10746
10734
  */
10747
10735
  hasNext?: boolean | null;
10748
10736
  }
10737
+ interface Cursors$4 {
10738
+ /** Cursor string pointing to the next page in the list of results. */
10739
+ next?: string | null;
10740
+ /** Cursor pointing to the previous page in the list of results. */
10741
+ prev?: string | null;
10742
+ }
10749
10743
  interface AggregationData {
10750
10744
  /** key = aggregation name (as derived from search request). */
10751
10745
  results?: AggregationResults[];
@@ -12770,7 +12764,9 @@ interface VideoResolution {
12770
12764
  }
12771
12765
  declare enum MediaType$1 {
12772
12766
  UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
12767
+ /** Image media type. */
12773
12768
  IMAGE = "IMAGE",
12769
+ /** Video media type. */
12774
12770
  VIDEO = "VIDEO"
12775
12771
  }
12776
12772
  interface Thumbnail$1 {
@@ -12855,8 +12851,11 @@ interface ConnectedOptionOptionSettingsOneOf$1 {
12855
12851
  choicesSettings?: ChoicesSettings$1;
12856
12852
  }
12857
12853
  declare enum ProductOptionRenderType$1 {
12854
+ /** Not implemented. */
12858
12855
  UNKNOWN_OPTION_RENDER_TYPE = "UNKNOWN_OPTION_RENDER_TYPE",
12856
+ /** Text choices. */
12859
12857
  TEXT_CHOICES = "TEXT_CHOICES",
12858
+ /** Swatch choices. */
12860
12859
  SWATCH_CHOICES = "SWATCH_CHOICES"
12861
12860
  }
12862
12861
  interface ChoicesSettings$1 {
@@ -12899,9 +12898,13 @@ interface ConnectedOptionChoiceValueOneOf$1 {
12899
12898
  }
12900
12899
  declare enum ChoiceType$1 {
12901
12900
  UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
12901
+ /** Text choice. */
12902
12902
  CHOICE_TEXT = "CHOICE_TEXT",
12903
+ /** Single color choice. */
12903
12904
  ONE_COLOR = "ONE_COLOR",
12905
+ /** Multiple colors choice. */
12904
12906
  MULTIPLE_COLORS = "MULTIPLE_COLORS",
12907
+ /** Image choice. */
12905
12908
  IMAGE = "IMAGE"
12906
12909
  }
12907
12910
  interface ConnectedModifier$1 extends ConnectedModifierModifierSettingsOneOf$1 {
@@ -12926,9 +12929,13 @@ interface ConnectedModifierModifierSettingsOneOf$1 {
12926
12929
  choicesSettings?: ModifierChoicesSettings$1;
12927
12930
  }
12928
12931
  declare enum ModifierRenderType$1 {
12932
+ /** Not implemented. */
12929
12933
  UNKNOWN_MODIFIER_RENDER_TYPE = "UNKNOWN_MODIFIER_RENDER_TYPE",
12934
+ /** Free text. */
12930
12935
  FREE_TEXT = "FREE_TEXT",
12936
+ /** Text choices. */
12931
12937
  TEXT_CHOICES = "TEXT_CHOICES",
12938
+ /** Swatch choices. */
12932
12939
  SWATCH_CHOICES = "SWATCH_CHOICES"
12933
12940
  }
12934
12941
  interface FreeTextSettings$1 {
@@ -13046,52 +13053,53 @@ interface FixedMonetaryAmount$1 {
13046
13053
  interface Inventory$1 {
13047
13054
  /**
13048
13055
  * Current availability status.
13049
- *
13050
- * + `IN_STOCK`: All variants are in stock and available for purchase
13051
- * + `OUT_OF_STOCK`: All variants are out of stock
13052
- * + `PARTIALLY_OUT_OF_STOCK`: Some variants are out of stock and some are in stock and available for purchase
13053
13056
  * @readonly
13054
13057
  */
13055
13058
  availabilityStatus?: InventoryAvailabilityStatus$1;
13056
13059
  /**
13057
- * Current preorder status/
13058
- *
13059
- * + `ENABLED`: All variants are enabled for preorder
13060
- * + `DISABLED`: All variants are disabled for preorder
13061
- * + `PARTIALLY_ENABLED`: Some variants are disabled and some are enabled for preorder
13060
+ * Current preorder status.
13062
13061
  * @readonly
13063
13062
  */
13064
13063
  preorderStatus?: PreorderStatus$1;
13065
13064
  /**
13066
- * Supported values:
13067
- * + `ALL_VARIANTS`: All the product variants are available for preorder.
13068
- * + `NO_VARIANTS`: None of the product variants are available for preorder.
13069
- * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
13065
+ * Preorder availability status.
13070
13066
  * @readonly
13071
13067
  */
13072
13068
  preorderAvailability?: ProductPreorderAvailability$1;
13073
13069
  }
13074
13070
  declare enum InventoryAvailabilityStatus$1 {
13075
13071
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
13072
+ /** All variants are in stock and available for purchase. */
13076
13073
  IN_STOCK = "IN_STOCK",
13074
+ /** All variants are out of stock. */
13077
13075
  OUT_OF_STOCK = "OUT_OF_STOCK",
13076
+ /** Some variants are out of stock and some are in stock and available for purchase. */
13078
13077
  PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
13079
13078
  }
13080
13079
  declare enum PreorderStatus$1 {
13081
13080
  UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
13081
+ /** All variants are enabled for preorder. */
13082
13082
  ENABLED = "ENABLED",
13083
+ /** All variants are disabled for preorder. */
13083
13084
  DISABLED = "DISABLED",
13085
+ /** Some variants are disabled and some are enabled for preorder. */
13084
13086
  PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
13085
13087
  }
13086
13088
  declare enum ProductPreorderAvailability$1 {
13087
13089
  UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
13090
+ /** All the product variants are available for preorder. */
13088
13091
  ALL_VARIANTS = "ALL_VARIANTS",
13092
+ /** None of the product variants are available for preorder. */
13089
13093
  NO_VARIANTS = "NO_VARIANTS",
13094
+ /** Some of the product variants are available for preorder. */
13090
13095
  SOME_VARIANTS = "SOME_VARIANTS"
13091
13096
  }
13092
13097
  declare enum ProductType$1 {
13098
+ /** Not implemented. */
13093
13099
  UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
13100
+ /** Physical product. */
13094
13101
  PHYSICAL = "PHYSICAL",
13102
+ /** Digital product. */
13095
13103
  DIGITAL = "DIGITAL"
13096
13104
  }
13097
13105
  interface PhysicalProperties$1 {
@@ -13365,11 +13373,17 @@ interface SecuredMedia$1 {
13365
13373
  fileType?: FileType$1;
13366
13374
  }
13367
13375
  declare enum FileType$1 {
13376
+ /** Unspecified file type. */
13368
13377
  UNSPECIFIED = "UNSPECIFIED",
13378
+ /** Secure picture file. */
13369
13379
  SECURE_PICTURE = "SECURE_PICTURE",
13380
+ /** Secure video file. */
13370
13381
  SECURE_VIDEO = "SECURE_VIDEO",
13382
+ /** Secure document file. */
13371
13383
  SECURE_DOCUMENT = "SECURE_DOCUMENT",
13384
+ /** Secure music file. */
13372
13385
  SECURE_MUSIC = "SECURE_MUSIC",
13386
+ /** Secure archive file. */
13373
13387
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
13374
13388
  }
13375
13389
  interface SubscriptionPricesInfo$1 {
@@ -13495,7 +13509,9 @@ interface SubscriptionDiscountDiscountOneOf$1 {
13495
13509
  }
13496
13510
  declare enum DiscountType$3 {
13497
13511
  UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT",
13512
+ /** Discount by a specific amount. */
13498
13513
  AMOUNT = "AMOUNT",
13514
+ /** Discount by a percentage. */
13499
13515
  PERCENT = "PERCENT"
13500
13516
  }
13501
13517
  interface VariantSummary$1 {
@@ -13517,11 +13533,12 @@ interface CreateProductRequest$1 {
13517
13533
  fields?: SingleEntityOpsRequestedFields$1[];
13518
13534
  }
13519
13535
  declare enum SingleEntityOpsRequestedFields$1 {
13536
+ /** Not implemented. */
13520
13537
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
13521
13538
  URL = "URL",
13522
13539
  CURRENCY = "CURRENCY",
13523
13540
  INFO_SECTION = "INFO_SECTION",
13524
- /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
13541
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
13525
13542
  MERCHANT_DATA = "MERCHANT_DATA",
13526
13543
  PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
13527
13544
  INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -13958,14 +13975,11 @@ interface InventoryItemTrackingMethodOneOf$1 {
13958
13975
  }
13959
13976
  declare enum AvailabilityStatus$1 {
13960
13977
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
13978
+ /** Product is out of stock. */
13961
13979
  OUT_OF_STOCK = "OUT_OF_STOCK",
13980
+ /** Product is in stock. See `quantity` field for exact amount in stock. */
13962
13981
  IN_STOCK = "IN_STOCK",
13963
- /**
13964
- * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
13965
- * 1. the variant is out of stock
13966
- * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
13967
- * 3. preorder limit wasn't reached (preorder_setting.limit)
13968
- */
13982
+ /** Product is only available for preorder. See `preorderInfo` field for more info. */
13969
13983
  PREORDER = "PREORDER"
13970
13984
  }
13971
13985
  interface Product$1 {
@@ -14029,11 +14043,12 @@ interface BulkCreateProductsRequest$1 {
14029
14043
  fields?: RequestedFields$3[];
14030
14044
  }
14031
14045
  declare enum RequestedFields$3 {
14046
+ /** Not implemented. */
14032
14047
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
14033
14048
  URL = "URL",
14034
14049
  CURRENCY = "CURRENCY",
14035
14050
  INFO_SECTION = "INFO_SECTION",
14036
- /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
14051
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
14037
14052
  MERCHANT_DATA = "MERCHANT_DATA",
14038
14053
  PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
14039
14054
  INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -17153,7 +17168,9 @@ interface ProductMediaMediaOneOf {
17153
17168
  }
17154
17169
  declare enum MediaType {
17155
17170
  UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
17171
+ /** Image media type. */
17156
17172
  IMAGE = "IMAGE",
17173
+ /** Video media type. */
17157
17174
  VIDEO = "VIDEO"
17158
17175
  }
17159
17176
  interface Thumbnail {
@@ -17238,8 +17255,11 @@ interface ConnectedOptionOptionSettingsOneOf {
17238
17255
  choicesSettings?: ChoicesSettings;
17239
17256
  }
17240
17257
  declare enum ProductOptionRenderType {
17258
+ /** Not implemented. */
17241
17259
  UNKNOWN_OPTION_RENDER_TYPE = "UNKNOWN_OPTION_RENDER_TYPE",
17260
+ /** Text choices. */
17242
17261
  TEXT_CHOICES = "TEXT_CHOICES",
17262
+ /** Swatch choices. */
17243
17263
  SWATCH_CHOICES = "SWATCH_CHOICES"
17244
17264
  }
17245
17265
  interface ChoicesSettings {
@@ -17282,9 +17302,13 @@ interface ConnectedOptionChoiceValueOneOf {
17282
17302
  }
17283
17303
  declare enum ChoiceType {
17284
17304
  UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
17305
+ /** Text choice. */
17285
17306
  CHOICE_TEXT = "CHOICE_TEXT",
17307
+ /** Single color choice. */
17286
17308
  ONE_COLOR = "ONE_COLOR",
17309
+ /** Multiple colors choice. */
17287
17310
  MULTIPLE_COLORS = "MULTIPLE_COLORS",
17311
+ /** Image choice. */
17288
17312
  IMAGE = "IMAGE"
17289
17313
  }
17290
17314
  interface ConnectedModifier extends ConnectedModifierModifierSettingsOneOf {
@@ -17309,9 +17333,13 @@ interface ConnectedModifierModifierSettingsOneOf {
17309
17333
  choicesSettings?: ModifierChoicesSettings;
17310
17334
  }
17311
17335
  declare enum ModifierRenderType {
17336
+ /** Not implemented. */
17312
17337
  UNKNOWN_MODIFIER_RENDER_TYPE = "UNKNOWN_MODIFIER_RENDER_TYPE",
17338
+ /** Free text. */
17313
17339
  FREE_TEXT = "FREE_TEXT",
17340
+ /** Text choices. */
17314
17341
  TEXT_CHOICES = "TEXT_CHOICES",
17342
+ /** Swatch choices. */
17315
17343
  SWATCH_CHOICES = "SWATCH_CHOICES"
17316
17344
  }
17317
17345
  interface FreeTextSettings {
@@ -17429,52 +17457,53 @@ interface FixedMonetaryAmount {
17429
17457
  interface Inventory {
17430
17458
  /**
17431
17459
  * Current availability status.
17432
- *
17433
- * + `IN_STOCK`: All variants are in stock and available for purchase
17434
- * + `OUT_OF_STOCK`: All variants are out of stock
17435
- * + `PARTIALLY_OUT_OF_STOCK`: Some variants are out of stock and some are in stock and available for purchase
17436
17460
  * @readonly
17437
17461
  */
17438
17462
  availabilityStatus?: InventoryAvailabilityStatus;
17439
17463
  /**
17440
- * Current preorder status/
17441
- *
17442
- * + `ENABLED`: All variants are enabled for preorder
17443
- * + `DISABLED`: All variants are disabled for preorder
17444
- * + `PARTIALLY_ENABLED`: Some variants are disabled and some are enabled for preorder
17464
+ * Current preorder status.
17445
17465
  * @readonly
17446
17466
  */
17447
17467
  preorderStatus?: PreorderStatus;
17448
17468
  /**
17449
- * Supported values:
17450
- * + `ALL_VARIANTS`: All the product variants are available for preorder.
17451
- * + `NO_VARIANTS`: None of the product variants are available for preorder.
17452
- * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
17469
+ * Preorder availability status.
17453
17470
  * @readonly
17454
17471
  */
17455
17472
  preorderAvailability?: ProductPreorderAvailability;
17456
17473
  }
17457
17474
  declare enum InventoryAvailabilityStatus {
17458
17475
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
17476
+ /** All variants are in stock and available for purchase. */
17459
17477
  IN_STOCK = "IN_STOCK",
17478
+ /** All variants are out of stock. */
17460
17479
  OUT_OF_STOCK = "OUT_OF_STOCK",
17480
+ /** Some variants are out of stock and some are in stock and available for purchase. */
17461
17481
  PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
17462
17482
  }
17463
17483
  declare enum PreorderStatus {
17464
17484
  UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
17485
+ /** All variants are enabled for preorder. */
17465
17486
  ENABLED = "ENABLED",
17487
+ /** All variants are disabled for preorder. */
17466
17488
  DISABLED = "DISABLED",
17489
+ /** Some variants are disabled and some are enabled for preorder. */
17467
17490
  PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
17468
17491
  }
17469
17492
  declare enum ProductPreorderAvailability {
17470
17493
  UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
17494
+ /** All the product variants are available for preorder. */
17471
17495
  ALL_VARIANTS = "ALL_VARIANTS",
17496
+ /** None of the product variants are available for preorder. */
17472
17497
  NO_VARIANTS = "NO_VARIANTS",
17498
+ /** Some of the product variants are available for preorder. */
17473
17499
  SOME_VARIANTS = "SOME_VARIANTS"
17474
17500
  }
17475
17501
  declare enum ProductType {
17502
+ /** Not implemented. */
17476
17503
  UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
17504
+ /** Physical product. */
17477
17505
  PHYSICAL = "PHYSICAL",
17506
+ /** Digital product. */
17478
17507
  DIGITAL = "DIGITAL"
17479
17508
  }
17480
17509
  interface PhysicalProperties {
@@ -17748,11 +17777,17 @@ interface SecuredMedia {
17748
17777
  fileType?: FileType;
17749
17778
  }
17750
17779
  declare enum FileType {
17780
+ /** Unspecified file type. */
17751
17781
  UNSPECIFIED = "UNSPECIFIED",
17782
+ /** Secure picture file. */
17752
17783
  SECURE_PICTURE = "SECURE_PICTURE",
17784
+ /** Secure video file. */
17753
17785
  SECURE_VIDEO = "SECURE_VIDEO",
17786
+ /** Secure document file. */
17754
17787
  SECURE_DOCUMENT = "SECURE_DOCUMENT",
17788
+ /** Secure music file. */
17755
17789
  SECURE_MUSIC = "SECURE_MUSIC",
17790
+ /** Secure archive file. */
17756
17791
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
17757
17792
  }
17758
17793
  interface SubscriptionPricesInfo {
@@ -17878,7 +17913,9 @@ interface SubscriptionDiscountDiscountOneOf {
17878
17913
  }
17879
17914
  declare enum DiscountType$2 {
17880
17915
  UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT",
17916
+ /** Discount by a specific amount. */
17881
17917
  AMOUNT = "AMOUNT",
17918
+ /** Discount by a percentage. */
17882
17919
  PERCENT = "PERCENT"
17883
17920
  }
17884
17921
  interface VariantSummary {
@@ -17900,11 +17937,12 @@ interface CreateProductRequest {
17900
17937
  fields?: SingleEntityOpsRequestedFields[];
17901
17938
  }
17902
17939
  declare enum SingleEntityOpsRequestedFields {
17940
+ /** Not implemented. */
17903
17941
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
17904
17942
  URL = "URL",
17905
17943
  CURRENCY = "CURRENCY",
17906
17944
  INFO_SECTION = "INFO_SECTION",
17907
- /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
17945
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
17908
17946
  MERCHANT_DATA = "MERCHANT_DATA",
17909
17947
  PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
17910
17948
  INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -18341,14 +18379,11 @@ interface InventoryItemTrackingMethodOneOf {
18341
18379
  }
18342
18380
  declare enum AvailabilityStatus {
18343
18381
  UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
18382
+ /** Product is out of stock. */
18344
18383
  OUT_OF_STOCK = "OUT_OF_STOCK",
18384
+ /** Product is in stock. See `quantity` field for exact amount in stock. */
18345
18385
  IN_STOCK = "IN_STOCK",
18346
- /**
18347
- * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
18348
- * 1. the variant is out of stock
18349
- * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
18350
- * 3. preorder limit wasn't reached (preorder_setting.limit)
18351
- */
18386
+ /** Product is only available for preorder. See `preorderInfo` field for more info. */
18352
18387
  PREORDER = "PREORDER"
18353
18388
  }
18354
18389
  interface Product {
@@ -18412,11 +18447,12 @@ interface BulkCreateProductsRequest {
18412
18447
  fields?: RequestedFields$2[];
18413
18448
  }
18414
18449
  declare enum RequestedFields$2 {
18450
+ /** Not implemented. */
18415
18451
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
18416
18452
  URL = "URL",
18417
18453
  CURRENCY = "CURRENCY",
18418
18454
  INFO_SECTION = "INFO_SECTION",
18419
- /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
18455
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
18420
18456
  MERCHANT_DATA = "MERCHANT_DATA",
18421
18457
  PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
18422
18458
  INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -20257,7 +20293,9 @@ interface Sorting$3 {
20257
20293
  order?: SortOrder$3;
20258
20294
  }
20259
20295
  declare enum SortOrder$3 {
20296
+ /** Ascending order. */
20260
20297
  ASC = "ASC",
20298
+ /** Descending order. */
20261
20299
  DESC = "DESC"
20262
20300
  }
20263
20301
  interface CursorPaging$3 {
@@ -20595,7 +20633,9 @@ interface Sorting$2 {
20595
20633
  order?: SortOrder$2;
20596
20634
  }
20597
20635
  declare enum SortOrder$2 {
20636
+ /** Ascending order. */
20598
20637
  ASC = "ASC",
20638
+ /** Descending order. */
20599
20639
  DESC = "DESC"
20600
20640
  }
20601
20641
  interface CursorPaging$2 {
@@ -20886,9 +20926,6 @@ interface StoresLocation$1 {
20886
20926
  wixLocationId?: string | null;
20887
20927
  /**
20888
20928
  * Location type.
20889
- *
20890
- * + `VIRTUAL`: Online store.
20891
- * + `PHYSICAL`: Physical location. For example, for POS.
20892
20929
  * @readonly
20893
20930
  */
20894
20931
  locationType?: LocationType$1;
@@ -20902,9 +20939,9 @@ interface StoresLocation$1 {
20902
20939
  }
20903
20940
  declare enum LocationType$1 {
20904
20941
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
20905
- /** Online stores location. */
20942
+ /** Online store. */
20906
20943
  VIRTUAL = "VIRTUAL",
20907
- /** Physical location like POS */
20944
+ /** Physical location, for example, POS. */
20908
20945
  PHYSICAL = "PHYSICAL"
20909
20946
  }
20910
20947
  interface GetStoresLocationRequest$1 {
@@ -21034,9 +21071,6 @@ interface StoresLocation {
21034
21071
  wixLocationId?: string | null;
21035
21072
  /**
21036
21073
  * Location type.
21037
- *
21038
- * + `VIRTUAL`: Online store.
21039
- * + `PHYSICAL`: Physical location. For example, for POS.
21040
21074
  * @readonly
21041
21075
  */
21042
21076
  locationType?: LocationType;
@@ -21050,9 +21084,9 @@ interface StoresLocation {
21050
21084
  }
21051
21085
  declare enum LocationType {
21052
21086
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
21053
- /** Online stores location. */
21087
+ /** Online store. */
21054
21088
  VIRTUAL = "VIRTUAL",
21055
- /** Physical location like POS */
21089
+ /** Physical location, for example, POS. */
21056
21090
  PHYSICAL = "PHYSICAL"
21057
21091
  }
21058
21092
  interface GetStoresLocationRequest {