@wix/stores 1.0.311 → 1.0.312

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/stores",
-  "version": "1.0.311",
+  "version": "1.0.312",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,17 +21,17 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/stores_brands-v-3": "1.0.29",
+    "@wix/stores_brands-v-3": "1.0.30",
     "@wix/stores_catalog-versioning": "1.0.14",
     "@wix/stores_collections": "1.0.49",
-    "@wix/stores_customizations-v-3": "1.0.31",
+    "@wix/stores_customizations-v-3": "1.0.32",
     "@wix/stores_info-sections-v-3": "1.0.31",
-    "@wix/stores_inventory": "1.0.67",
-    "@wix/stores_inventory-items-v-3": "1.0.36",
+    "@wix/stores_inventory": "1.0.68",
+    "@wix/stores_inventory-items-v-3": "1.0.37",
     "@wix/stores_products": "1.0.92",
-    "@wix/stores_products-v-3": "1.0.79",
-    "@wix/stores_ribbons-v-3": "1.0.25",
-    "@wix/stores_stores-locations-v-3": "1.0.31",
+    "@wix/stores_products-v-3": "1.0.80",
+    "@wix/stores_ribbons-v-3": "1.0.26",
+    "@wix/stores_stores-locations-v-3": "1.0.32",
     "@wix/stores_subscription-options": "1.0.50",
     "@wix/stores_wishlist": "1.0.43"
   },
@@ -58,5 +58,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "8f67a5137b01d205ea2056f99853e642b3d47c5152e75928baf0d28e"
+  "falconPackageHash": "d9a805b3a8074420cda8506e763e64069baeea42d853ee6dc8f03be3"
 }

package/type-bundles/context.bundle.d.ts

@@ -3799,7 +3799,9 @@ interface Sorting$6 {
     order?: SortOrder$6;
 }
 declare enum SortOrder$6 {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface CursorPaging$6 {
@@ -4708,9 +4710,13 @@ interface ChoiceValueOneOf {
 }
 declare enum ChoiceType$1 {
     UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
+    /** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
     CHOICE_TEXT = "CHOICE_TEXT",
+    /** For `customizationRenderType: SWATCH_CHOICES`. */
     ONE_COLOR = "ONE_COLOR",
+    /** For `customizationRenderType: SWATCH_CHOICES`. */
     MULTIPLE_COLORS = "MULTIPLE_COLORS",
+    /** For `customizationRenderType: SWATCH_CHOICES`. */
     IMAGE = "IMAGE"
 }
 interface MultipleColors$1 {
@@ -4804,7 +4810,9 @@ interface GetCustomizationRequest {
     fields?: RequestedFields$3[];
 }
 declare enum RequestedFields$3 {
+    /** Unknown requested field. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** Assigned products count. */
     ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
 }
 interface GetCustomizationResponse {
@@ -4871,7 +4879,9 @@ interface Sorting$5 {
     order?: SortOrder$5;
 }
 declare enum SortOrder$5 {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface CursorPaging$5 {
@@ -8392,14 +8402,11 @@ interface InventoryItemTrackingMethodOneOf$1 {
 }
 declare enum AvailabilityStatus$1 {
     UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
+    /** Product is out of stock. */
     OUT_OF_STOCK = "OUT_OF_STOCK",
+    /** Product is in stock. See `quantity` field for exact amount in stock. */
     IN_STOCK = "IN_STOCK",
-    /**
-     * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
-     * 1. the variant is out of stock
-     * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
-     * 3. preorder limit wasn't reached (preorder_setting.limit)
-     */
+    /** Product is only available for preorder. See `preorderInfo` field for more info. */
     PREORDER = "PREORDER"
 }
 interface PreorderInfo$2 {
@@ -11842,7 +11849,9 @@ interface VideoResolution {
 }
 declare enum MediaType {
     UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
+    /** Image media type. */
     IMAGE = "IMAGE",
+    /** Video media type. */
     VIDEO = "VIDEO"
 }
 interface Thumbnail {
@@ -11927,8 +11936,11 @@ interface ConnectedOptionOptionSettingsOneOf {
     choicesSettings?: ChoicesSettings;
 }
 declare enum ProductOptionRenderType {
+    /** Not implemented. */
     UNKNOWN_OPTION_RENDER_TYPE = "UNKNOWN_OPTION_RENDER_TYPE",
+    /** Text choices. */
     TEXT_CHOICES = "TEXT_CHOICES",
+    /** Swatch choices. */
     SWATCH_CHOICES = "SWATCH_CHOICES"
 }
 interface ChoicesSettings {
@@ -11971,9 +11983,13 @@ interface ConnectedOptionChoiceValueOneOf {
 }
 declare enum ChoiceType {
     UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
+    /** Text choice. */
     CHOICE_TEXT = "CHOICE_TEXT",
+    /** Single color choice. */
     ONE_COLOR = "ONE_COLOR",
+    /** Multiple colors choice. */
     MULTIPLE_COLORS = "MULTIPLE_COLORS",
+    /** Image choice. */
     IMAGE = "IMAGE"
 }
 interface MultipleColors {
@@ -12002,9 +12018,13 @@ interface ConnectedModifierModifierSettingsOneOf {
     choicesSettings?: ModifierChoicesSettings;
 }
 declare enum ModifierRenderType {
+    /** Not implemented. */
     UNKNOWN_MODIFIER_RENDER_TYPE = "UNKNOWN_MODIFIER_RENDER_TYPE",
+    /** Free text. */
     FREE_TEXT = "FREE_TEXT",
+    /** Text choices. */
     TEXT_CHOICES = "TEXT_CHOICES",
+    /** Swatch choices. */
     SWATCH_CHOICES = "SWATCH_CHOICES"
 }
 interface FreeTextSettings {
@@ -12129,52 +12149,53 @@ interface FixedMonetaryAmount {
 interface Inventory {
     /**
      * Current availability status.
-     *
-     * + `IN_STOCK`: All variants are in stock and available for purchase
-     * + `OUT_OF_STOCK`: All variants are out of stock
-     * + `PARTIALLY_OUT_OF_STOCK`: Some variants are out of stock and some are in stock and available for purchase
      * @readonly
      */
     availabilityStatus?: InventoryAvailabilityStatus;
     /**
-     * Current preorder status/
-     *
-     * + `ENABLED`: All variants are enabled for preorder
-     * + `DISABLED`: All variants are disabled for preorder
-     * + `PARTIALLY_ENABLED`: Some variants are disabled and some are enabled for preorder
+     * Current preorder status.
      * @readonly
      */
     preorderStatus?: PreorderStatus;
     /**
-     * Supported values:
-     * + `ALL_VARIANTS`: All the product variants are available for preorder.
-     * + `NO_VARIANTS`: None of the product variants are available for preorder.
-     * + `SOME_VARIANTS`: Some of the product variants are available for preorder.
+     * Preorder availability status.
      * @readonly
      */
     preorderAvailability?: ProductPreorderAvailability;
 }
 declare enum InventoryAvailabilityStatus {
     UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
+    /** All variants are in stock and available for purchase. */
     IN_STOCK = "IN_STOCK",
+    /** All variants are out of stock. */
     OUT_OF_STOCK = "OUT_OF_STOCK",
+    /** Some variants are out of stock and some are in stock and available for purchase. */
     PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
 }
 declare enum PreorderStatus {
     UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
+    /** All variants are enabled for preorder. */
     ENABLED = "ENABLED",
+    /** All variants are disabled for preorder. */
     DISABLED = "DISABLED",
+    /** Some variants are disabled and some are enabled for preorder. */
     PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
 }
 declare enum ProductPreorderAvailability {
     UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
+    /** All the product variants are available for preorder. */
     ALL_VARIANTS = "ALL_VARIANTS",
+    /** None of the product variants are available for preorder. */
     NO_VARIANTS = "NO_VARIANTS",
+    /** Some of the product variants are available for preorder. */
     SOME_VARIANTS = "SOME_VARIANTS"
 }
 declare enum ProductType {
+    /** Not implemented. */
     UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
+    /** Physical product. */
     PHYSICAL = "PHYSICAL",
+    /** Digital product. */
     DIGITAL = "DIGITAL"
 }
 interface PhysicalProperties {
@@ -12448,11 +12469,17 @@ interface SecuredMedia {
     fileType?: FileType;
 }
 declare enum FileType {
+    /** Unspecified file type. */
     UNSPECIFIED = "UNSPECIFIED",
+    /** Secure picture file. */
     SECURE_PICTURE = "SECURE_PICTURE",
+    /** Secure video file. */
     SECURE_VIDEO = "SECURE_VIDEO",
+    /** Secure document file. */
     SECURE_DOCUMENT = "SECURE_DOCUMENT",
+    /** Secure music file. */
     SECURE_MUSIC = "SECURE_MUSIC",
+    /** Secure archive file. */
     SECURE_ARCHIVE = "SECURE_ARCHIVE"
 }
 interface SubscriptionPricesInfo {
@@ -12578,7 +12605,9 @@ interface SubscriptionDiscountDiscountOneOf {
 }
 declare enum DiscountType$1 {
     UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT",
+    /** Discount by a specific amount. */
     AMOUNT = "AMOUNT",
+    /** Discount by a percentage. */
     PERCENT = "PERCENT"
 }
 interface VariantSummary {
@@ -12874,11 +12903,12 @@ interface CreateProductRequest {
     fields?: SingleEntityOpsRequestedFields[];
 }
 declare enum SingleEntityOpsRequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     URL = "URL",
     CURRENCY = "CURRENCY",
     INFO_SECTION = "INFO_SECTION",
-    /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
+    /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
     MERCHANT_DATA = "MERCHANT_DATA",
     PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
     INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -13325,14 +13355,11 @@ interface InventoryItemTrackingMethodOneOf {
 }
 declare enum AvailabilityStatus {
     UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
+    /** Product is out of stock. */
     OUT_OF_STOCK = "OUT_OF_STOCK",
+    /** Product is in stock. See `quantity` field for exact amount in stock. */
     IN_STOCK = "IN_STOCK",
-    /**
-     * Whether the variant is available for preorder. InventoryItem will be available only when all below conditions are met:
-     * 1. the variant is out of stock
-     * 2. preorder is enabled on inventory item level (preorder_setting.enabled is true)
-     * 3. preorder limit wasn't reached (preorder_setting.limit)
-     */
+    /** Product is only available for preorder. See `preorderInfo` field for more info. */
     PREORDER = "PREORDER"
 }
 interface Product {
@@ -13400,11 +13427,12 @@ interface BulkCreateProductsRequest {
     fields?: RequestedFields$1[];
 }
 declare enum RequestedFields$1 {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     URL = "URL",
     CURRENCY = "CURRENCY",
     INFO_SECTION = "INFO_SECTION",
-    /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
+    /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
     MERCHANT_DATA = "MERCHANT_DATA",
     PLAIN_DESCRIPTION = "PLAIN_DESCRIPTION",
     INFO_SECTION_PLAIN_DESCRIPTION = "INFO_SECTION_PLAIN_DESCRIPTION",
@@ -14478,7 +14506,9 @@ interface Sorting$2 {
     order?: SortOrder$2;
 }
 declare enum SortOrder$2 {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface Aggregation extends AggregationKindOneOf {
@@ -14519,21 +14549,21 @@ interface RangeBucket {
     to?: number | null;
 }
 declare enum SortType {
-    /** Should sort by number of matches */
+    /** Should sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Should sort by value of the field alphabetically. */
     VALUE = "VALUE"
 }
 declare enum SortDirection {
-    /** Should sort in descending order */
+    /** Should sort by descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Should sort by ascending order. */
     ASC = "ASC"
 }
 declare enum MissingValues {
-    /** Should missing values be excluded from the aggregation results */
+    /** Exclude missing values from the aggregation results. */
     EXCLUDE = "EXCLUDE",
-    /** Should missing values be included in the aggregation results */
+    /** Include missing values from the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface IncludeMissingValuesOptions {
@@ -14541,16 +14571,17 @@ interface IncludeMissingValuesOptions {
     addToBucket?: string;
 }
 declare enum ScalarType {
+    /** Undefined scalar type. */
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Count of distinct values */
+    /** Count of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
-    /** Minimum value */
+    /** Minimum value. */
     MIN = "MIN",
-    /** Maximum value */
+    /** Maximum value. */
     MAX = "MAX",
-    /** Sum of values */
+    /** Sum of values. */
     SUM = "SUM",
-    /** Average of values */
+    /** Average of values. */
     AVG = "AVG"
 }
 interface ValueAggregation extends ValueAggregationOptionsOneOf {
@@ -14571,14 +14602,15 @@ interface ValueAggregationOptionsOneOf {
     includeOptions?: IncludeMissingValuesOptions;
 }
 declare enum NestedAggregationType {
+    /** Undefined nested aggregation type. */
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation where user can define set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation. For example: min, max, sum, avg. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface RangeAggregation {
@@ -14594,20 +14626,21 @@ interface DateHistogramAggregation {
     interval?: Interval;
 }
 declare enum Interval {
+    /** Undefined interval type. */
     UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
-    /** Yearly interval */
+    /** Yearly interval. */
     YEAR = "YEAR",
-    /** Monthly interval */
+    /** Monthly interval. */
     MONTH = "MONTH",
-    /** Weekly interval */
+    /** Weekly interval. */
     WEEK = "WEEK",
-    /** Daily interval */
+    /** Daily interval. */
     DAY = "DAY",
-    /** Hourly interval */
+    /** Hourly interval. */
     HOUR = "HOUR",
-    /** Minute interval */
+    /** Minute interval. */
     MINUTE = "MINUTE",
-    /** Second interval */
+    /** Second interval. */
     SECOND = "SECOND"
 }
 interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -14638,16 +14671,17 @@ interface NestedAggregationItemKindOneOf {
     dateHistogram?: DateHistogramAggregation;
 }
 declare enum AggregationType {
+    /** Undefined aggregation type. */
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation where a user can define set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation. For example: min, max, sum, avg. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
-    /** Multi-level aggregation, where each next aggregation is nested within previous one */
+    /** A Multi-level aggregation where each next aggregation is nested within previous one. */
     NESTED = "NESTED"
 }
 /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
@@ -14656,7 +14690,7 @@ interface NestedAggregation {
     nestedAggregations?: NestedAggregationItem[];
 }
 interface SearchDetails {
-    /** Defines how separate search terms in `expression` are combined */
+    /** Defines how separate search terms in `expression` are combined. */
     mode?: Mode;
     /** Search term or expression */
     expression?: string | null;
@@ -14666,9 +14700,9 @@ interface SearchDetails {
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** Any of the search terms must be present */
+    /** Any of the search terms must be present. */
     OR = "OR",
-    /** All search terms must be present */
+    /** All search terms must be present. */
     AND = "AND"
 }
 interface CursorPaging$2 {
@@ -15252,9 +15286,10 @@ interface VariantsCursorPaging {
     cursor?: string | null;
 }
 declare enum VariantsOpsRequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     CURRENCY = "CURRENCY",
-    /** You can request merchant data only if you have `WIX_STORES.PRODUCT_MERCHANT_DATA_READ` permission. */
+    /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
     MERCHANT_DATA = "MERCHANT_DATA",
     SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
     VARIANT_OPTION_CHOICE_NAMES = "VARIANT_OPTION_CHOICE_NAMES",
@@ -15567,20 +15602,21 @@ interface UnsignedAdjustValueAdjustValueOneOf {
     percentage?: number;
 }
 declare enum RoundingStrategy {
+    /** Undefined rounding strategy. */
     UNKNOWN_ROUNDING_STRATEGY = "UNKNOWN_ROUNDING_STRATEGY",
     /**
-     * Calculated prices will be saved without rounding to keep max possible precision. It's still good idea to round numbers before displaying them.
-     * Example: input $3.5555 -> saved value $3.5555
+     * Calculated prices are saved without rounding to keep the maximum possible precision. It's a good idea to round numbers before displaying them.
+     * For example, input $3.5555 -> saved value $3.5555
      */
     NO_ROUNDING = "NO_ROUNDING",
     /**
-     * Calculated prices will be rounded according to currency precision.
-     * Example: input $3.5555 -> saved value $3.56, input ¥3.5555 -> saved value ¥4
+     * Calculated prices are rounded according to currency precision.
+     * For example:, input $3.5555 -> saved value $3.56, input ¥3.5555 -> saved value ¥4
      */
     CURRENCY_PRECISION = "CURRENCY_PRECISION",
     /**
-     * Calculated prices will be rounded to nearest whole number.
-     * Example: input $3.5555 -> saved value $4
+     * Calculated prices are rounded to nearest whole number.
+     * For example, input $3.5555 -> saved value $4
      */
     NEAREST_WHOLE_NUMBER = "NEAREST_WHOLE_NUMBER"
 }
@@ -18560,7 +18596,9 @@ interface Sorting$1 {
     order?: SortOrder$1;
 }
 declare enum SortOrder$1 {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface CursorPaging$1 {
@@ -19365,9 +19403,6 @@ interface StoresLocation {
     wixLocationId?: string | null;
     /**
      * Location type.
-     *
-     * + `VIRTUAL`: Online store.
-     * + `PHYSICAL`: Physical location. For example, for POS.
      * @readonly
      */
     locationType?: LocationType;
@@ -19381,9 +19416,9 @@ interface StoresLocation {
 }
 declare enum LocationType {
     UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
-    /** Online stores location. */
+    /** Online store. */
     VIRTUAL = "VIRTUAL",
-    /** Physical location like POS */
+    /** Physical location, for example, POS. */
     PHYSICAL = "PHYSICAL"
 }
 interface InvalidateCache extends InvalidateCacheGetByOneOf {
@@ -20574,9 +20609,13 @@ interface ChangedInventoryVariantData {
     availableForPreorder?: boolean;
 }
 declare enum ReasonType {
+    /** Unknown reason. */
     UNKNOWN = "UNKNOWN",
+    /** Order related. */
     ORDER = "ORDER",
+    /** Manual adjustment. */
     MANUAL = "MANUAL",
+    /** Reverting an inventory change. */
     REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE"
 }
 interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {