@wix/auto_sdk_ecom_cart-v-2 1.0.0 → 1.0.2

package/build/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { CreateCartRequest as CreateCartRequest$1, CreateCartResponse as CreateCartResponse$1, GetCartRequest as GetCartRequest$1, GetCartResponse as GetCartResponse$1, UpdateCartRequest as UpdateCartRequest$1, UpdateCartResponse as UpdateCartResponse$1, DeleteCartRequest as DeleteCartRequest$1, DeleteCartResponse as DeleteCartResponse$1, RefreshCartRequest as RefreshCartRequest$1, RefreshCartResponse as RefreshCartResponse$1, CalculateCartRequest as CalculateCartRequest$1, CalculateCartResponse as CalculateCartResponse$1, GetCheckoutURLRequest as GetCheckoutURLRequest$1, GetCheckoutURLResponse as GetCheckoutURLResponse$1, CompleteCheckoutRequest as CompleteCheckoutRequest$1, CompleteCheckoutResponse as CompleteCheckoutResponse$1, AddLineItemsRequest as AddLineItemsRequest$1, AddLineItemsResponse as AddLineItemsResponse$1, RemoveLineItemsRequest as RemoveLineItemsRequest$1, RemoveLineItemsResponse as RemoveLineItemsResponse$1, AddDiscountRequest as AddDiscountRequest$1, AddDiscountResponse as AddDiscountResponse$1, RemoveDiscountRequest as RemoveDiscountRequest$1, RemoveDiscountResponse as RemoveDiscountResponse$1, AddGiftCardRequest as AddGiftCardRequest$1, AddGiftCardResponse as AddGiftCardResponse$1, RemoveGiftCardRequest as RemoveGiftCardRequest$1, RemoveGiftCardResponse as RemoveGiftCardResponse$1, UpdateLineItemsRequest as UpdateLineItemsRequest$1, UpdateLineItemsResponse as UpdateLineItemsResponse$1, MarkCartAsCompletedRequest as MarkCartAsCompletedRequest$1, MarkCartAsCompletedResponse as MarkCartAsCompletedResponse$1, HandleAsyncCheckoutCompletionRequest as HandleAsyncCheckoutCompletionRequest$1, RawHttpResponse as RawHttpResponse$1 } from './index.js';
+import { CreateCartRequest as CreateCartRequest$1, CreateCartResponse as CreateCartResponse$1, GetCartRequest as GetCartRequest$1, GetCartResponse as GetCartResponse$1, UpdateCartRequest as UpdateCartRequest$1, UpdateCartResponse as UpdateCartResponse$1, DeleteCartRequest as DeleteCartRequest$1, DeleteCartResponse as DeleteCartResponse$1, RefreshCartRequest as RefreshCartRequest$1, RefreshCartResponse as RefreshCartResponse$1, CalculateCartRequest as CalculateCartRequest$1, CalculateCartResponse as CalculateCartResponse$1, GetCheckoutURLRequest as GetCheckoutURLRequest$1, GetCheckoutURLResponse as GetCheckoutURLResponse$1, PlaceOrderRequest as PlaceOrderRequest$1, PlaceOrderResponse as PlaceOrderResponse$1, AddLineItemsRequest as AddLineItemsRequest$1, AddLineItemsResponse as AddLineItemsResponse$1, RemoveLineItemsRequest as RemoveLineItemsRequest$1, RemoveLineItemsResponse as RemoveLineItemsResponse$1, UpdateLineItemsRequest as UpdateLineItemsRequest$1, UpdateLineItemsResponse as UpdateLineItemsResponse$1, AddDiscountRequest as AddDiscountRequest$1, AddDiscountResponse as AddDiscountResponse$1, RemoveDiscountRequest as RemoveDiscountRequest$1, RemoveDiscountResponse as RemoveDiscountResponse$1, AddGiftCardRequest as AddGiftCardRequest$1, AddGiftCardResponse as AddGiftCardResponse$1, RemoveGiftCardRequest as RemoveGiftCardRequest$1, RemoveGiftCardResponse as RemoveGiftCardResponse$1, MarkCartAsCompletedRequest as MarkCartAsCompletedRequest$1, MarkCartAsCompletedResponse as MarkCartAsCompletedResponse$1, HandleAsyncCheckoutCompletionRequest as HandleAsyncCheckoutCompletionRequest$1, RawHttpResponse as RawHttpResponse$1 } from './index.js';
 
 interface Cart {
     /**
@@ -22,11 +22,6 @@ interface Cart {
      * @readonly
      */
     revision?: string | null;
-    /**
-     * Custom fields.
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
-     */
-    extendedFields?: ExtendedFields;
     /**
      * Line items added to the Cart by the customer.
      * This list may include both valid items (in stock) and invalid ones (e.g., out of stock).
@@ -35,6 +30,14 @@ interface Cart {
      * @readonly
      */
     lineItems?: V2LineItem[];
+    /** The sum of all line item final prices. */
+    subtotal?: MultiCurrencyPrice;
+    /**
+     * Optional message left by the customer.
+     * Usually intended for the merchant and contain special instructions, requests, or clarifications related to the order.
+     * @maxLength 1000
+     */
+    note?: string | null;
     /**
      * The discounts of the Cart.
      * Automatic discounts are removed from the Cart entirely when they are no longer valid.
@@ -46,7 +49,7 @@ interface Cart {
     /** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
     source?: CartSource;
     /** Information about the site from which the Cart's line items were added. */
-    siteInfo?: SiteInfo;
+    businessInfo?: BusinessInfo;
     /** Information about the customer that owns the Cart. */
     customerInfo?: CustomerInfo;
     /** Delivery-related information associated with the Cart. */
@@ -56,15 +59,24 @@ interface Cart {
     /** Payment-related information associated with the Cart. */
     paymentInfo?: PaymentInfo;
     /**
-     * The estimated costs that the customer will pay.
+     * Whether the Cart has been placed as an Order.
+     * Defaults to `false`.
      * @readonly
      */
-    pricingInfo?: PricingInfo;
+    orderPlaced?: boolean;
     /**
-     * The current status of the Cart.
+     * The ID of the Order created from the Cart.
+     * This field is empty until the checkout process is completed.
+     * @format GUID
+     * @readonly
+     */
+    orderId?: string | null;
+    /**
+     * Persistent ID that correlates between the Cart and the created Order (after the checkout is completed).
+     * @format GUID
      * @readonly
      */
-    status?: CartStatusWithLiterals;
+    purchaseFlowId?: string | null;
     /**
      * Additional Cart settings.
      *
@@ -73,7 +85,7 @@ interface Cart {
      * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
      * @immutable
      */
-    customSettings?: CustomSettings;
+    settings?: CartSettings;
     /**
      * Custom checkout URL to redirect the customer to a checkout page.
      * By default, customers are redirected to the standard Wix checkout page.
@@ -83,29 +95,10 @@ interface Cart {
      */
     customCheckoutUrl?: string | null;
     /**
-     * The ID of the Order created from the Cart.
-     * This field is empty until the checkout process is completed.
-     * @format GUID
-     * @readonly
-     */
-    orderId?: string | null;
-    /**
-     * Persistent ID that correlates between the Cart and the created Order (after the checkout is completed).
-     * @format GUID
-     * @readonly
-     */
-    purchaseFlowId?: string | null;
-}
-interface ExtendedFields {
-    /**
-     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
-     * The value of each key is structured according to the schema defined when the extended fields were configured.
-     *
-     * You can only access fields for which you have the appropriate permissions.
-     *
-     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     * Custom fields.
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
      */
-    namespaces?: Record<string, Record<string, any>>;
+    extendedFields?: ExtendedFields;
 }
 interface V2LineItem {
     /**
@@ -148,10 +141,10 @@ interface V2LineItem {
      */
     modifierGroups?: ModifierGroup[];
     /**
-     * Whether the item can only be purchased by site members.
-     * Default: `false`
+     * Whether the line item is a custom line item.
+     * Custom line items don't trigger the Catalog service plugin.
      */
-    membersOnly?: boolean;
+    customLineItem?: boolean;
 }
 interface TranslatableString {
     /**
@@ -190,7 +183,10 @@ interface ItemQuantityInfo {
     requestedQuantity?: number;
     /** The maximum quantity of items available for purchase. */
     availableQuantity?: number | null;
-    /** Whether the line item quantity is fixed and cannot be changed. */
+    /**
+     * Whether the line item quantity is fixed and cannot be changed.
+     * Default: `false`.
+     */
     fixedQuantity?: boolean;
 }
 interface ItemPricingInfo {
@@ -273,11 +269,6 @@ interface ItemPriceBreakdown {
     totalDiscount?: MultiCurrencyPrice;
 }
 interface ItemSource {
-    /**
-     * Whether the line item is a custom line item.
-     * Custom line items don't trigger the Catalog service plugin.
-     */
-    customLineItem?: boolean;
     /**
      * Catalog and item reference.
      * Holds IDs for the item and the catalog it came from, as well as further optional info.
@@ -531,6 +522,11 @@ interface ItemAttributes {
     subscriptionInfo?: SubscriptionOptionInfo;
     /** Service properties. When relevant, this contains information such as date and number of participants. */
     serviceProperties?: ServiceProperties;
+    /**
+     * Whether the item can only be purchased by site members.
+     * Default: `false`
+     */
+    membersOnly?: boolean;
 }
 interface PageUrlV2 {
     /**
@@ -761,16 +757,27 @@ interface V2SelectedMembership {
 declare enum ItemStatus {
     UNKNOWN_ITEM_STATUS = "UNKNOWN_ITEM_STATUS",
     /** The item is available in the requested quantity. */
-    AVAILABLE = "AVAILABLE",
+    IN_STOCK = "IN_STOCK",
     /** Only part of the requested quantity is available. */
-    PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE",
+    PARTIALLY_IN_STOCK = "PARTIALLY_IN_STOCK",
     /** The item is out of stock. */
     OUT_OF_STOCK = "OUT_OF_STOCK",
     /** The item is no longer exists in the catalog. */
-    NOT_EXISTS = "NOT_EXISTS"
+    REMOVED_FROM_CATALOG = "REMOVED_FROM_CATALOG"
 }
 /** @enumType */
-type ItemStatusWithLiterals = ItemStatus | 'UNKNOWN_ITEM_STATUS' | 'AVAILABLE' | 'PARTIALLY_AVAILABLE' | 'OUT_OF_STOCK' | 'NOT_EXISTS';
+type ItemStatusWithLiterals = ItemStatus | 'UNKNOWN_ITEM_STATUS' | 'IN_STOCK' | 'PARTIALLY_IN_STOCK' | 'OUT_OF_STOCK' | 'REMOVED_FROM_CATALOG';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
 interface AdditionalFee {
     /**
      * Additional fee's unique code or ID.
@@ -1083,18 +1090,13 @@ interface CustomContentReference {
      */
     componentId?: string;
 }
-interface SiteInfo {
+interface BusinessInfo {
     /**
      * The ID of the business location associated with the cart.
      * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
      * @format GUID
      */
-    businessLocationId?: string | null;
-    /**
-     * The business’s unit of weight measurement (e.g., KG, LB).
-     * @readonly
-     */
-    weightUnit?: WeightUnitWithLiterals;
+    locationId?: string | null;
     /**
      * The business’s default language, represented as a two-letter ISO 639-1 code.
      * @format LANGUAGE
@@ -1108,16 +1110,6 @@ interface SiteInfo {
      */
     currencyCode?: string;
 }
-declare enum WeightUnit {
-    /** Weight unit can't be classified due to an error. */
-    UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
-    /** Kilograms. */
-    KG = "KG",
-    /** Pounds. */
-    LB = "LB"
-}
-/** @enumType */
-type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
 interface CustomerInfo extends CustomerInfoIdOneOf {
     /**
      * Site visitor ID (if site visitor is **not** a member).
@@ -1165,11 +1157,6 @@ interface CustomerInfo extends CustomerInfoIdOneOf {
      * @readonly
      */
     currencyCode?: string;
-    /**
-     * The [buyer note](https://support.wix.com/en/article/wix-stores-viewing-customer-notes) left by the customer.
-     * @maxLength 1000
-     */
-    buyerNote?: string | null;
 }
 /** @oneof */
 interface CustomerInfoIdOneOf {
@@ -1200,6 +1187,11 @@ interface DeliveryInfo {
     recipient?: FullAddressContactDetails;
     /** The selected delivery method by the customer. */
     method?: DeliveryMethod;
+    /**
+     * The unit of weight measurement when shipping items (e.g., KG, LB).
+     * @readonly
+     */
+    weightUnit?: WeightUnitWithLiterals;
 }
 /** Physical address */
 interface Address {
@@ -1323,6 +1315,16 @@ interface DeliveryMethod {
      */
     pickup?: boolean;
 }
+declare enum WeightUnit {
+    /** Weight unit can't be classified due to an error. */
+    UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
+    /** Kilograms. */
+    KG = "KG",
+    /** Pounds. */
+    LB = "LB"
+}
+/** @enumType */
+type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
 interface TaxInfo {
     /**
      * Indicates whether tax is already included in prices (line items, discounts, delivery, additional fess).
@@ -1376,23 +1378,7 @@ interface GiftCard {
      */
     externalId?: string | null;
 }
-interface PricingInfo {
-    /** The sum of all line items after applying automatic discounts. */
-    subtotal?: MultiCurrencyPrice;
-    /** The coupon discount amount. Automatic discounts are not included in this amount. */
-    discount?: MultiCurrencyPrice;
-    /** The sum of all line items after applying all discounts. */
-    discountedSubtotal?: MultiCurrencyPrice;
-}
-declare enum CartStatus {
-    /** A new Cart. */
-    CREATED = "CREATED",
-    /** The checkout process is completed. */
-    CHECKOUT_COMPLETED = "CHECKOUT_COMPLETED"
-}
-/** @enumType */
-type CartStatusWithLiterals = CartStatus | 'CREATED' | 'CHECKOUT_COMPLETED';
-interface CustomSettings {
+interface CartSettings {
     /**
      * Whether to restrict the option to add or remove a gift card on the checkout page.
      * Default: `false`
@@ -1596,7 +1582,7 @@ interface AdditionalFeeTax {
 interface PriceSummary {
     /**
      * Total price of all line items after applying item-level discounts.
-     * FIXME: Currently we don't know if the subtotal includes tax or not.
+     * Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
      */
     subtotal?: MultiCurrencyPrice;
     /**
@@ -1607,20 +1593,17 @@ interface PriceSummary {
     discount?: MultiCurrencyPrice;
     /**
      * Final delivery cost for the cart.
-     * FIXME: Currently we don't know if the subtotal includes tax or not.
+     * Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
      */
     delivery?: MultiCurrencyPrice;
     /**
      * Total additional fees associated with the cart.
-     * FIXME: Currently we don't know if the subtotal includes tax or not.
+     * Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
      */
     additionalFees?: MultiCurrencyPrice;
     /** Total tax amount calculated across all applicable components (items, discounts, delivery, and fees). */
     tax?: MultiCurrencyPrice;
-    /**
-     * Total amount to be paid.
-     * Curenntly, total = subtotal - discount + delivery + additional_fees + tax.
-     */
+    /** Total amount to be paid. */
     total?: MultiCurrencyPrice;
 }
 interface PaymentSummary {
@@ -1815,11 +1798,6 @@ interface CustomItemInput {
      * @maxSize 25
      */
     modifierGroups?: ModifierGroup[];
-    /**
-     * Whether the item can only be purchased by site members.
-     * Default: `false`
-     */
-    membersOnly?: boolean;
 }
 interface CustomItemQuantityInfo {
     /**
@@ -1900,6 +1878,11 @@ interface CustomItemAttributes {
     subscriptionInfo?: SubscriptionOptionInfo;
     /** Service properties. When relevant, this contains information such as date and number of participants. */
     serviceProperties?: ServiceProperties;
+    /**
+     * Whether the item can only be purchased by site members.
+     * Default: `false`
+     */
+    membersOnly?: boolean;
 }
 interface CustomItemDeliveryConfig {
     /**
@@ -1971,9 +1954,9 @@ interface LineItemUpdate {
      */
     lineItemId?: string;
     /** Quantity update (optional - if not provided, quantity is not updated) */
-    quantityUpdate?: QuantityUpdate;
+    quantity?: QuantityUpdate;
     /** Selected membership update (optional - if not provided, membership is not updated) */
-    selectedMembershipUpdate?: SelectedMembershipUpdate;
+    selectedMembership?: SelectedMembershipUpdate;
 }
 interface QuantityUpdate {
     /**
@@ -1981,7 +1964,7 @@ interface QuantityUpdate {
      * @min 1
      * @max 100000
      */
-    quantity?: number;
+    newQuantity?: number;
 }
 interface SelectedMembershipUpdate {
     /**
@@ -1989,7 +1972,7 @@ interface SelectedMembershipUpdate {
      *
      * To just remove current selected membership, and not replace with a new one, pass an empty value here.
      */
-    membership?: V2SelectedMembership;
+    newMembership?: V2SelectedMembership;
 }
 interface CreateCartRequest {
     /** Cart to be created. */
@@ -2112,7 +2095,7 @@ interface GetCheckoutURLResponse {
      */
     checkoutUrl?: string;
 }
-interface CompleteCheckoutRequest {
+interface PlaceOrderRequest {
     /**
      * Cart ID.
      * @format GUID
@@ -2154,7 +2137,7 @@ interface RedirectUrls {
      */
     pendingUrl?: string | null;
 }
-interface CompleteCheckoutResponse {
+interface PlaceOrderResponse {
     /**
      * The order ID of the created order.
      * @format GUID
@@ -2216,6 +2199,23 @@ interface RemoveLineItemsResponse {
     /** Updated Cart. */
     cart?: Cart;
 }
+interface UpdateLineItemsRequest {
+    /**
+     * Cart ID.
+     * @format GUID
+     */
+    cartId: string;
+    /**
+     * Line item updates to apply.
+     * @minSize 1
+     * @maxSize 300
+     */
+    lineItems?: LineItemUpdate[];
+}
+interface UpdateLineItemsResponse {
+    /** Updated Cart. */
+    cart?: Cart;
+}
 interface AddDiscountRequest {
     /**
      * Cart ID.
@@ -2285,23 +2285,6 @@ interface RemoveGiftCardResponse {
     /** Updated Cart. */
     cart?: Cart;
 }
-interface UpdateLineItemsRequest {
-    /**
-     * Cart ID.
-     * @format GUID
-     */
-    cartId: string;
-    /**
-     * Line item updates to apply.
-     * @minSize 1
-     * @maxSize 100
-     */
-    lineItemUpdates?: LineItemUpdate[];
-}
-interface UpdateLineItemsResponse {
-    /** Updated Cart. */
-    cart?: Cart;
-}
 interface MarkCartAsCompletedRequest {
     /**
      * Cart ID.
@@ -2364,15 +2347,18 @@ declare function calculateCart(): __PublicMethodMetaInfo<'POST', {
 declare function getCheckoutUrl(): __PublicMethodMetaInfo<'POST', {
     cartId: string;
 }, GetCheckoutURLRequest$1, GetCheckoutURLRequest, GetCheckoutURLResponse$1, GetCheckoutURLResponse>;
-declare function completeCheckout(): __PublicMethodMetaInfo<'POST', {
+declare function placeOrder(): __PublicMethodMetaInfo<'POST', {
     cartId: string;
-}, CompleteCheckoutRequest$1, CompleteCheckoutRequest, CompleteCheckoutResponse$1, CompleteCheckoutResponse>;
+}, PlaceOrderRequest$1, PlaceOrderRequest, PlaceOrderResponse$1, PlaceOrderResponse>;
 declare function addLineItems(): __PublicMethodMetaInfo<'POST', {
     cartId: string;
 }, AddLineItemsRequest$1, AddLineItemsRequest, AddLineItemsResponse$1, AddLineItemsResponse>;
 declare function removeLineItems(): __PublicMethodMetaInfo<'POST', {
     cartId: string;
 }, RemoveLineItemsRequest$1, RemoveLineItemsRequest, RemoveLineItemsResponse$1, RemoveLineItemsResponse>;
+declare function updateLineItems(): __PublicMethodMetaInfo<'POST', {
+    cartId: string;
+}, UpdateLineItemsRequest$1, UpdateLineItemsRequest, UpdateLineItemsResponse$1, UpdateLineItemsResponse>;
 declare function addDiscount(): __PublicMethodMetaInfo<'POST', {
     cartId: string;
 }, AddDiscountRequest$1, AddDiscountRequest, AddDiscountResponse$1, AddDiscountResponse>;
@@ -2385,12 +2371,9 @@ declare function addGiftCard(): __PublicMethodMetaInfo<'POST', {
 declare function removeGiftCard(): __PublicMethodMetaInfo<'POST', {
     cartId: string;
 }, RemoveGiftCardRequest$1, RemoveGiftCardRequest, RemoveGiftCardResponse$1, RemoveGiftCardResponse>;
-declare function updateLineItems(): __PublicMethodMetaInfo<'POST', {
-    cartId: string;
-}, UpdateLineItemsRequest$1, UpdateLineItemsRequest, UpdateLineItemsResponse$1, UpdateLineItemsResponse>;
 declare function markCartAsCompleted(): __PublicMethodMetaInfo<'POST', {
     cartId: string;
 }, MarkCartAsCompletedRequest$1, MarkCartAsCompletedRequest, MarkCartAsCompletedResponse$1, MarkCartAsCompletedResponse>;
 declare function handleAsyncCheckoutCompletion(): __PublicMethodMetaInfo<'POST', {}, HandleAsyncCheckoutCompletionRequest$1, HandleAsyncCheckoutCompletionRequest, RawHttpResponse$1, RawHttpResponse>;
 
-export { type __PublicMethodMetaInfo, addDiscount, addGiftCard, addLineItems, calculateCart, completeCheckout, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, refreshCart, removeDiscount, removeGiftCard, removeLineItems, updateCart, updateLineItems };
+export { type __PublicMethodMetaInfo, addDiscount, addGiftCard, addLineItems, calculateCart, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, placeOrder, refreshCart, removeDiscount, removeGiftCard, removeLineItems, updateCart, updateLineItems };