@wix/ecom 1.0.853 → 1.0.855

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

@@ -496,14 +496,7 @@ interface MembershipInvalidSelectionError extends MembershipInvalidSelectionErro
     membershipSelectionInvalidReason?: string | null;
     /** Membership ID. */
     membershipId?: string;
-    /**
-     * Error type.
-     *
-     * + MEMBERSHIP_NOT_FOUND: Membership not found.
-     * + LINE_ITEM_NOT_FOUND: The selection points to a line item ID that wasn't provided.
-     * + MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS: The membership cannot be used for the specific line items provided.
-     * + MEMBERSHIP_SELECTION_INVALID: The membership can be used for each individual line item, but combining all of them is invalid.
-     */
+    /** Error type. */
     errorType?: MembershipErrorType;
 }
 /** @oneof */
@@ -517,12 +510,13 @@ interface MembershipInvalidSelectionErrorErrorDataOneOf {
 }
 declare enum MembershipErrorType {
     UNKNOWN = "UNKNOWN",
+    /** Membership not found. */
     MEMBERSHIP_NOT_FOUND = "MEMBERSHIP_NOT_FOUND",
-    /** which line item ids */
+    /** The selection points to a line item ID that wasn't provided. */
     LINE_ITEM_NOT_FOUND = "LINE_ITEM_NOT_FOUND",
-    /** which ids and why */
+    /** The membership cannot be used for the specific line items provided. */
     MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS = "MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS",
-    /** reason */
+    /** The membership can be used for each individual line item, but combining all of them is invalid. */
     MEMBERSHIP_SELECTION_INVALID = "MEMBERSHIP_SELECTION_INVALID"
 }
 interface LineItemNotFoundInfo {
@@ -600,9 +594,13 @@ interface MembershipCannotBeChargedErrorErrorDataOneOf {
     ended?: Ended;
 }
 declare enum MembershipCannotBeChargedType {
+    /** Membership is out of credits. For example, 5 are required, but only 4 remain. */
     OUT_OF_CREDITS = "OUT_OF_CREDITS",
+    /** Membership has not become active yet. */
     NOT_STARTED_YET = "NOT_STARTED_YET",
+    /** Membership has expired or ended. */
     ENDED = "ENDED",
+    /** Not applicable for multiple participants. */
     NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS = "NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS"
 }
 interface OutOfCredits {
@@ -1927,8 +1925,11 @@ interface AppliedDiscountDiscountSourceOneOf$2 {
     discountRule?: DiscountRule$2;
 }
 declare enum DiscountType$2 {
+    /** Global discount. */
     GLOBAL = "GLOBAL",
+    /** Discount on specific items. */
     SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
+    /** Discount on shipping. */
     SHIPPING = "SHIPPING"
 }
 /** Coupon */
@@ -3047,8 +3048,11 @@ interface Color {
     code?: string | null;
 }
 declare enum DescriptionLineType {
+    /** Unrecognized type. */
     UNRECOGNISED = "UNRECOGNISED",
+    /** Plain text type. */
     PLAIN_TEXT = "PLAIN_TEXT",
+    /** Color type. */
     COLOR = "COLOR"
 }
 interface FocalPoint {
@@ -3093,11 +3097,11 @@ declare enum ItemTypeItemType$1 {
 declare enum PaymentOptionType {
     /** The entire payment for this item happens as part of the checkout. */
     FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
-    /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
+    /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
     FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
     /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
     MEMBERSHIP = "MEMBERSHIP",
-    /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
+    /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
     DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
     /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
     MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -3280,14 +3284,14 @@ declare enum PaymentStatus {
     PARTIALLY_PAID = "PARTIALLY_PAID"
 }
 declare enum FulfillmentStatus {
-    /** none of the order items are fulfilled or order was manually marked as unfulfilled */
+    /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
     NOT_FULFILLED = "NOT_FULFILLED",
     /**
-     * All of the order items are fulfilled or order was manually marked as fulfilled
-     * Orders without shipping info are fulfilled automatically
+     * All of the order items are fulfilled or the order was manually marked as fulfilled.
+     * Orders without shipping info are fulfilled automatically.
      */
     FULFILLED = "FULFILLED",
-    /** Some, but not all of the order items are fulfilled */
+    /** Some, but not all, of the order items are fulfilled. */
     PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
 }
 declare enum WeightUnit$1 {
@@ -3384,7 +3388,7 @@ declare enum VatType$1 {
 interface V1ShippingInformation {
     /** App Def Id of external provider which was a source of shipping info */
     carrierId?: string | null;
-    /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
+    /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
     code?: string | null;
     /**
      * Shipping option title.
@@ -3743,7 +3747,9 @@ interface LineItemQuantityChange {
     deltaType?: LineItemQuantityChangeType;
 }
 declare enum LineItemQuantityChangeType {
+    /** Quantity increased. */
     QUANTITY_INCREASED = "QUANTITY_INCREASED",
+    /** Quantity decreased. */
     QUANTITY_DECREASED = "QUANTITY_DECREASED"
 }
 interface LineItemPriceChange {
@@ -4589,20 +4595,16 @@ declare enum V1JurisdictionType {
     SPECIAL = "SPECIAL"
 }
 interface ItemAvailabilityInfo {
-    /**
-     * Item availability status.
-     * + `"NOT_FOUND"`: Item does not exist
-     * + `"NOT_AVAILABLE"`: Item not in stock
-     * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
-     */
+    /** Item availability status. */
     status?: ItemAvailabilityStatus;
     /** Quantity available. */
     quantityAvailable?: number | null;
 }
 declare enum ItemAvailabilityStatus {
     AVAILABLE = "AVAILABLE",
+    /** Item does not exist */
     NOT_FOUND = "NOT_FOUND",
-    /** Not in stock */
+    /** Item not in stock */
     NOT_AVAILABLE = "NOT_AVAILABLE",
     /** Available quantity is less than requested */
     PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -5396,12 +5398,12 @@ interface TargetTargetTypeOneOf$1 {
 }
 /** Available locations on the webpage */
 declare enum NameInOther$1 {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     OTHER_DEFAULT = "OTHER_DEFAULT"
 }
 /** Available locations on the line item */
 declare enum NameInLineItem$1 {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
 }
 declare enum SuggestedFix$1 {
@@ -5810,28 +5812,22 @@ declare enum Source {
     CHECKOUT = "CHECKOUT"
 }
 interface Stage extends StageStagesOneOf {
-    /**
-     * Supported values:
-     * + "INITIALIZATION":Used during the initialization of the checkout (Create Checkout).
-     * + "IN_PROGRESS": Used during the checkout process, such as updating or retrieving the checkout.
-     * + "ORDER_CREATION": Used during the creation of an order from the checkout.
-     */
+    /** Supported values: */
     checkoutStage?: CheckoutStage;
 }
 /** @oneof */
 interface StageStagesOneOf {
-    /**
-     * Supported values:
-     * + "INITIALIZATION":Used during the initialization of the checkout (Create Checkout).
-     * + "IN_PROGRESS": Used during the checkout process, such as updating or retrieving the checkout.
-     * + "ORDER_CREATION": Used during the creation of an order from the checkout.
-     */
+    /** Supported values: */
     checkoutStage?: CheckoutStage;
 }
 declare enum CheckoutStage {
+    /** Not implemented. */
     UNKNOWN_CHECKOUT_STAGE = "UNKNOWN_CHECKOUT_STAGE",
+    /** Used during the initialization of the checkout (Create Checkout). */
     INITIALIZATION = "INITIALIZATION",
+    /** Used during the checkout process, such as updating or retrieving the checkout. */
     IN_PROGRESS = "IN_PROGRESS",
+    /** Used during the creation of an order from the checkout. */
     ORDER_CREATION = "ORDER_CREATION"
 }
 /** ValidationsData is the main entity of ValidationsSPI, which contains all the data required for validations */
@@ -6089,11 +6085,17 @@ interface TaxBreakdown {
 }
 /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
 declare enum JurisdictionType {
+    /** Undefined jurisdiction type. */
     UNDEFINED = "UNDEFINED",
+    /** Country jurisdiction. */
     COUNTRY = "COUNTRY",
+    /** State jurisdiction. */
     STATE = "STATE",
+    /** County jurisdiction. */
     COUNTY = "COUNTY",
+    /** City jurisdiction. */
     CITY = "CITY",
+    /** Special jurisdiction. */
     SPECIAL = "SPECIAL"
 }
 interface GiftCard {
@@ -6285,8 +6287,11 @@ interface AppliedDiscountDiscountSourceOneOf {
     discountRule?: DiscountRule;
 }
 declare enum DiscountType {
+    /** Global discount. */
     GLOBAL = "GLOBAL",
+    /** Discount for specific items. */
     SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
+    /** Shipping discount. */
     SHIPPING = "SHIPPING"
 }
 /** Coupon */
@@ -6374,12 +6379,12 @@ interface TargetTargetTypeOneOf {
 }
 /** Available locations on the webpage */
 declare enum NameInOther {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     OTHER_DEFAULT = "OTHER_DEFAULT"
 }
 /** Available locations on the line item */
 declare enum NameInLineItem {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
 }
 declare enum SuggestedFix {

package/type-bundles/service-plugins.bundle.d.ts

@@ -496,14 +496,7 @@ interface MembershipInvalidSelectionError extends MembershipInvalidSelectionErro
     membershipSelectionInvalidReason?: string | null;
     /** Membership ID. */
     membershipId?: string;
-    /**
-     * Error type.
-     *
-     * + MEMBERSHIP_NOT_FOUND: Membership not found.
-     * + LINE_ITEM_NOT_FOUND: The selection points to a line item ID that wasn't provided.
-     * + MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS: The membership cannot be used for the specific line items provided.
-     * + MEMBERSHIP_SELECTION_INVALID: The membership can be used for each individual line item, but combining all of them is invalid.
-     */
+    /** Error type. */
     errorType?: MembershipErrorType;
 }
 /** @oneof */
@@ -517,12 +510,13 @@ interface MembershipInvalidSelectionErrorErrorDataOneOf {
 }
 declare enum MembershipErrorType {
     UNKNOWN = "UNKNOWN",
+    /** Membership not found. */
     MEMBERSHIP_NOT_FOUND = "MEMBERSHIP_NOT_FOUND",
-    /** which line item ids */
+    /** The selection points to a line item ID that wasn't provided. */
     LINE_ITEM_NOT_FOUND = "LINE_ITEM_NOT_FOUND",
-    /** which ids and why */
+    /** The membership cannot be used for the specific line items provided. */
     MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS = "MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS",
-    /** reason */
+    /** The membership can be used for each individual line item, but combining all of them is invalid. */
     MEMBERSHIP_SELECTION_INVALID = "MEMBERSHIP_SELECTION_INVALID"
 }
 interface LineItemNotFoundInfo {
@@ -600,9 +594,13 @@ interface MembershipCannotBeChargedErrorErrorDataOneOf {
     ended?: Ended;
 }
 declare enum MembershipCannotBeChargedType {
+    /** Membership is out of credits. For example, 5 are required, but only 4 remain. */
     OUT_OF_CREDITS = "OUT_OF_CREDITS",
+    /** Membership has not become active yet. */
     NOT_STARTED_YET = "NOT_STARTED_YET",
+    /** Membership has expired or ended. */
     ENDED = "ENDED",
+    /** Not applicable for multiple participants. */
     NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS = "NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS"
 }
 interface OutOfCredits {
@@ -1927,8 +1925,11 @@ interface AppliedDiscountDiscountSourceOneOf$2 {
     discountRule?: DiscountRule$2;
 }
 declare enum DiscountType$2 {
+    /** Global discount. */
     GLOBAL = "GLOBAL",
+    /** Discount on specific items. */
     SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
+    /** Discount on shipping. */
     SHIPPING = "SHIPPING"
 }
 /** Coupon */
@@ -3047,8 +3048,11 @@ interface Color {
     code?: string | null;
 }
 declare enum DescriptionLineType {
+    /** Unrecognized type. */
     UNRECOGNISED = "UNRECOGNISED",
+    /** Plain text type. */
     PLAIN_TEXT = "PLAIN_TEXT",
+    /** Color type. */
     COLOR = "COLOR"
 }
 interface FocalPoint {
@@ -3093,11 +3097,11 @@ declare enum ItemTypeItemType$1 {
 declare enum PaymentOptionType {
     /** The entire payment for this item happens as part of the checkout. */
     FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
-    /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
+    /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
     FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
     /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
     MEMBERSHIP = "MEMBERSHIP",
-    /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
+    /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
     DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
     /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
     MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -3280,14 +3284,14 @@ declare enum PaymentStatus {
     PARTIALLY_PAID = "PARTIALLY_PAID"
 }
 declare enum FulfillmentStatus {
-    /** none of the order items are fulfilled or order was manually marked as unfulfilled */
+    /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
     NOT_FULFILLED = "NOT_FULFILLED",
     /**
-     * All of the order items are fulfilled or order was manually marked as fulfilled
-     * Orders without shipping info are fulfilled automatically
+     * All of the order items are fulfilled or the order was manually marked as fulfilled.
+     * Orders without shipping info are fulfilled automatically.
      */
     FULFILLED = "FULFILLED",
-    /** Some, but not all of the order items are fulfilled */
+    /** Some, but not all, of the order items are fulfilled. */
     PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
 }
 declare enum WeightUnit$1 {
@@ -3384,7 +3388,7 @@ declare enum VatType$1 {
 interface V1ShippingInformation {
     /** App Def Id of external provider which was a source of shipping info */
     carrierId?: string | null;
-    /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
+    /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
     code?: string | null;
     /**
      * Shipping option title.
@@ -3743,7 +3747,9 @@ interface LineItemQuantityChange {
     deltaType?: LineItemQuantityChangeType;
 }
 declare enum LineItemQuantityChangeType {
+    /** Quantity increased. */
     QUANTITY_INCREASED = "QUANTITY_INCREASED",
+    /** Quantity decreased. */
     QUANTITY_DECREASED = "QUANTITY_DECREASED"
 }
 interface LineItemPriceChange {
@@ -4589,20 +4595,16 @@ declare enum V1JurisdictionType {
     SPECIAL = "SPECIAL"
 }
 interface ItemAvailabilityInfo {
-    /**
-     * Item availability status.
-     * + `"NOT_FOUND"`: Item does not exist
-     * + `"NOT_AVAILABLE"`: Item not in stock
-     * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
-     */
+    /** Item availability status. */
     status?: ItemAvailabilityStatus;
     /** Quantity available. */
     quantityAvailable?: number | null;
 }
 declare enum ItemAvailabilityStatus {
     AVAILABLE = "AVAILABLE",
+    /** Item does not exist */
     NOT_FOUND = "NOT_FOUND",
-    /** Not in stock */
+    /** Item not in stock */
     NOT_AVAILABLE = "NOT_AVAILABLE",
     /** Available quantity is less than requested */
     PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -5396,12 +5398,12 @@ interface TargetTargetTypeOneOf$1 {
 }
 /** Available locations on the webpage */
 declare enum NameInOther$1 {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     OTHER_DEFAULT = "OTHER_DEFAULT"
 }
 /** Available locations on the line item */
 declare enum NameInLineItem$1 {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
 }
 declare enum SuggestedFix$1 {
@@ -5810,28 +5812,22 @@ declare enum Source {
     CHECKOUT = "CHECKOUT"
 }
 interface Stage extends StageStagesOneOf {
-    /**
-     * Supported values:
-     * + "INITIALIZATION":Used during the initialization of the checkout (Create Checkout).
-     * + "IN_PROGRESS": Used during the checkout process, such as updating or retrieving the checkout.
-     * + "ORDER_CREATION": Used during the creation of an order from the checkout.
-     */
+    /** Supported values: */
     checkoutStage?: CheckoutStage;
 }
 /** @oneof */
 interface StageStagesOneOf {
-    /**
-     * Supported values:
-     * + "INITIALIZATION":Used during the initialization of the checkout (Create Checkout).
-     * + "IN_PROGRESS": Used during the checkout process, such as updating or retrieving the checkout.
-     * + "ORDER_CREATION": Used during the creation of an order from the checkout.
-     */
+    /** Supported values: */
     checkoutStage?: CheckoutStage;
 }
 declare enum CheckoutStage {
+    /** Not implemented. */
     UNKNOWN_CHECKOUT_STAGE = "UNKNOWN_CHECKOUT_STAGE",
+    /** Used during the initialization of the checkout (Create Checkout). */
     INITIALIZATION = "INITIALIZATION",
+    /** Used during the checkout process, such as updating or retrieving the checkout. */
     IN_PROGRESS = "IN_PROGRESS",
+    /** Used during the creation of an order from the checkout. */
     ORDER_CREATION = "ORDER_CREATION"
 }
 /** ValidationsData is the main entity of ValidationsSPI, which contains all the data required for validations */
@@ -6089,11 +6085,17 @@ interface TaxBreakdown {
 }
 /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
 declare enum JurisdictionType {
+    /** Undefined jurisdiction type. */
     UNDEFINED = "UNDEFINED",
+    /** Country jurisdiction. */
     COUNTRY = "COUNTRY",
+    /** State jurisdiction. */
     STATE = "STATE",
+    /** County jurisdiction. */
     COUNTY = "COUNTY",
+    /** City jurisdiction. */
     CITY = "CITY",
+    /** Special jurisdiction. */
     SPECIAL = "SPECIAL"
 }
 interface GiftCard {
@@ -6285,8 +6287,11 @@ interface AppliedDiscountDiscountSourceOneOf {
     discountRule?: DiscountRule;
 }
 declare enum DiscountType {
+    /** Global discount. */
     GLOBAL = "GLOBAL",
+    /** Discount for specific items. */
     SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
+    /** Shipping discount. */
     SHIPPING = "SHIPPING"
 }
 /** Coupon */
@@ -6374,12 +6379,12 @@ interface TargetTargetTypeOneOf {
 }
 /** Available locations on the webpage */
 declare enum NameInOther {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     OTHER_DEFAULT = "OTHER_DEFAULT"
 }
 /** Available locations on the line item */
 declare enum NameInLineItem {
-    /** default location, in case no specific location is specified */
+    /** Default location, in case no specific location is specified. */
     LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
 }
 declare enum SuggestedFix {