@wix/auto_sdk_ecom_current-cart 1.0.134 → 1.0.136

package/build/cjs/index.typings.d.ts

@@ -2993,6 +2993,12 @@ interface RemoveBusinessLocationResponse {
     /** Updated cart. */
     cart?: Cart;
 }
+/** @docsIgnore */
+type GetCurrentCartApplicationErrors = {
+    code?: 'OWNED_CART_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -3128,17 +3134,21 @@ interface CartCreatedEnvelope {
  */
 declare function onCartCreated(handler: (event: CartCreatedEnvelope) => void | Promise<void>): void;
 /**
- * Retrieves the current site visitor's cart.
+ * Retrieves the current site visitor/member's cart.
  *
- * >**Note:**
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities).
+ * >**Notes:**
+ * > + A 'current cart' is automatically created when the site visitor/member adds an item to their cart, or when calling [Add To Current Cart](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/cart/cart/add-to-current-cart).
+ * > + Calling this method before adding an item to the cart will return a 404 error.
+ * > + This method requires [visitor or member authentication](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities).
  * @public
  * @permissionId ECOM.READ_CARTS
  * @applicableIdentity APP
  * @returns Current session's active cart.
  * @fqn com.wix.ecom.cart.api.v1.CurrentCartService.GetCurrentCart
  */
-declare function getCurrentCart(): Promise<NonNullablePaths<Cart, `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.productName.original` | `lineItems.${number}.price.amount` | `lineItems.${number}.price.convertedAmount` | `lineItems.${number}.price.formattedAmount` | `lineItems.${number}.price.formattedConvertedAmount` | `lineItems.${number}.availability.status` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionOptionInfo.title.original` | `lineItems.${number}.subscriptionOptionInfo.description.original` | `lineItems.${number}.paymentOption` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.selectedMembership._id` | `lineItems.${number}.selectedMembership.appId` | `lineItems.${number}.customLineItem` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `lineItems.${number}.savePaymentMethod` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.membersOnly` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `buyerInfo.userId` | `currency` | `conversionCurrency` | `weightUnit` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `contactInfo.address.streetAddress.number` | `contactInfo.address.streetAddress.name` | `contactInfo.contactDetails.vatId._id` | `contactInfo.contactDetails.vatId.type` | `selectedShippingOption.code` | `paymentCurrency`, 6>>;
+declare function getCurrentCart(): Promise<NonNullablePaths<Cart, `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.productName.original` | `lineItems.${number}.price.amount` | `lineItems.${number}.price.convertedAmount` | `lineItems.${number}.price.formattedAmount` | `lineItems.${number}.price.formattedConvertedAmount` | `lineItems.${number}.availability.status` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionOptionInfo.title.original` | `lineItems.${number}.subscriptionOptionInfo.description.original` | `lineItems.${number}.paymentOption` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.selectedMembership._id` | `lineItems.${number}.selectedMembership.appId` | `lineItems.${number}.customLineItem` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `lineItems.${number}.savePaymentMethod` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.membersOnly` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `buyerInfo.userId` | `currency` | `conversionCurrency` | `weightUnit` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `contactInfo.address.streetAddress.number` | `contactInfo.address.streetAddress.name` | `contactInfo.contactDetails.vatId._id` | `contactInfo.contactDetails.vatId.type` | `selectedShippingOption.code` | `paymentCurrency`, 6> & {
+    __applicationErrorsType?: GetCurrentCartApplicationErrors;
+}>;
 /**
  * Updates the current site visitor's cart.
  *
@@ -3365,4 +3375,4 @@ interface EstimateCurrentCartTotalsOptions {
  */
 declare function deleteCurrentCart(): Promise<void>;
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, type AddToCurrentCartOptions, type AddToCurrentCartRequest, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, type AggregatedTaxBreakdown, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, type AutoTaxFallbackCalculationDetails, BalanceType, type BalanceTypeWithLiterals, type BaseEventMetadata, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedItemModifier, type CalculatedLineItem, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type Cart, type CartCreatedEnvelope, type CartDeletedEnvelope, type CartDiscount, type CartDiscountDiscountSourceOneOf, type CartUpdatedEnvelope, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type Coupon, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutFromCurrentCartOptions, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutRequest, type CreateCheckoutResponse, type CustomLineItem, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeliveryAllocation, type DeliveryLogistics, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EstimateCurrentCartTotalsOptions, type EstimateCurrentCartTotalsRequest, type EstimateTotalsRequest, type EstimateTotalsResponse, type EventMetadata, type ExtendedFields, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartByCheckoutIdRequest, type GetCartByCheckoutIdResponse, type GetCartRequest, type GetCartResponse, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type Group, type HostSelectedMembership, type IdentificationData, type IdentificationDataIdOneOf, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemAvailabilityStatusWithLiterals, type ItemCombination, type ItemCombinationLineItem, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItem, type LineItemAdded, type LineItemDiscount, type LineItemPricesData, type LineItemQuantityUpdate, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MerchantDiscountInput, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type OtherCharge, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, PlatformFeeChargeType, type PlatformFeeChargeTypeWithLiterals, type Policy, type PriceDescription, type PriceSummary, type ProductName, RateType, type RateTypeWithLiterals, type Region, type RemoveBusinessLocationRequest, type RemoveBusinessLocationResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type SelectedShippingOption, type ServiceProperties, Severity, type SeverityWithLiterals, type ShippingInformation, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, type UpdateCurrentCartOptions, type UpdateLineItemsQuantityRequest, type UpdateLineItemsQuantityResponse, type V1Coupon, type V1DiscountRule, type V1DiscountRuleName, type V1ItemModifier, type V1MerchantDiscount, type V1ModifierGroup, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addToCurrentCart, createCheckoutFromCurrentCart, deleteCurrentCart, estimateCurrentCartTotals, getCurrentCart, onCartCreated, onCartDeleted, onCartUpdated, removeCouponFromCurrentCart, removeLineItemsFromCurrentCart, updateCurrentCart, updateCurrentCartLineItemQuantity };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, type AddToCurrentCartOptions, type AddToCurrentCartRequest, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, type AggregatedTaxBreakdown, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, type AutoTaxFallbackCalculationDetails, BalanceType, type BalanceTypeWithLiterals, type BaseEventMetadata, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedItemModifier, type CalculatedLineItem, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type Cart, type CartCreatedEnvelope, type CartDeletedEnvelope, type CartDiscount, type CartDiscountDiscountSourceOneOf, type CartUpdatedEnvelope, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type Coupon, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutFromCurrentCartOptions, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutRequest, type CreateCheckoutResponse, type CustomLineItem, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeliveryAllocation, type DeliveryLogistics, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EstimateCurrentCartTotalsOptions, type EstimateCurrentCartTotalsRequest, type EstimateTotalsRequest, type EstimateTotalsResponse, type EventMetadata, type ExtendedFields, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartByCheckoutIdRequest, type GetCartByCheckoutIdResponse, type GetCartRequest, type GetCartResponse, type GetCurrentCartApplicationErrors, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type Group, type HostSelectedMembership, type IdentificationData, type IdentificationDataIdOneOf, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemAvailabilityStatusWithLiterals, type ItemCombination, type ItemCombinationLineItem, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItem, type LineItemAdded, type LineItemDiscount, type LineItemPricesData, type LineItemQuantityUpdate, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MerchantDiscountInput, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type OtherCharge, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, PlatformFeeChargeType, type PlatformFeeChargeTypeWithLiterals, type Policy, type PriceDescription, type PriceSummary, type ProductName, RateType, type RateTypeWithLiterals, type Region, type RemoveBusinessLocationRequest, type RemoveBusinessLocationResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type SelectedShippingOption, type ServiceProperties, Severity, type SeverityWithLiterals, type ShippingInformation, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, type UpdateCurrentCartOptions, type UpdateLineItemsQuantityRequest, type UpdateLineItemsQuantityResponse, type V1Coupon, type V1DiscountRule, type V1DiscountRuleName, type V1ItemModifier, type V1MerchantDiscount, type V1ModifierGroup, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addToCurrentCart, createCheckoutFromCurrentCart, deleteCurrentCart, estimateCurrentCartTotals, getCurrentCart, onCartCreated, onCartDeleted, onCartUpdated, removeCouponFromCurrentCart, removeLineItemsFromCurrentCart, updateCurrentCart, updateCurrentCartLineItemQuantity };